Creating a New Service for SOTI Snap Data Access Controller
Create a RESTful API service by connecting to an existing database. SOTI Snap applications can then perform create, read, update and delete (CRUD) operations on database table data using the API.
About this task
Procedure
- From the SOTI Snap Data Access Controller web console, select the Services tab.
-
From the Services tab, select New
Service.
-
Select the Database Server Type.
-
Setup the Connection to the database server.
- Database Hostname / IP: The hostname / network address that has the database server.
- Port: The hostname / network address' respective port number.
- Username: A name of the database user to access the database server.
- Password: The database username's respective password.
- Select Test Connection to verify that you can successfully connect to the database server.
-
If you can successfully connect to the database server, continue to setup the
Connection to the database server.
- Database: Choose a database from the database server.
- Database Schema: Choose a schema from the database you have chosen.
-
Select the Tables in the database server to receive API
endpoints.
- Optional: Enable Allow custom SELECT queries to display tables with composite keys and / or no primary key.
- For the Table Name, choose the tables you would like to Create API Endpoint for and / or ALLOW FOR CUSTOM SELECT QUERIES for.
-
Select the Routines, the stored procedures and created
functions.
- For Procedure Name, choose the stored procedures that the API endpoint can access.
- For Function Name, choose the created functions that custom SELECT queries can access.
Restriction: You must choose at least one table or procedure to create an API endpoint for. -
Setup the Authentication account that accesses the API
endpoint.
-
In the Summary step, preview all the selections and
choices. Select Back to make changes. You can also edit
your selections and choices after you create the service as needed.
- Select Create Service to create the service.