In the vConnect module, this function allows you to define a service. While creating or adding a new service on the vConnect module, it is recommended that you first define a service and its details, and then register one or more APIs.
To define a service and its details:
- On the home page of the vConnect module, find the Service Management tab.
- Click the Service Management tab, and then click Add New Service, and the Service Details page opens with the selected Service Details tab.
- On the Service Details page, enter the details of a new service as follows:
|Service Name||In this box, enter the name of the service.|
|Description||In this box, enter a brief description of the service.|
|Keys To Mask||In this box, enter one or more parameters if you want to mask the value of a parameter in the API. To add more than one parameter, you need to separate them by a comma (,) character without pressing SPACEBAR.|
|Stop On Error||In this list, select one of the following values:|
i. “Y”:- Select Y if you want to stop the API after its execution fails and raises the error.
ii. “N”:- Select N if you want the API to continue the function even after its execution raises an error.
|API Execution Mode||In this list, select one of the following values:|
Sequence: – Select this value if you want the APIs to execute sequentially. Sequential execution means that an API will start its job only after the currently executing API finishes its job.
Parallel: – Select this value if you want all the APIs to perform the job simultaneously.
|Audit Enabled||In this list, select one of the following values:|
i. “Y”:- Select Y if you want the server to automatically create the logs related to the functions of the API. In this case, you need to access the vLog module to access and view the logs.
ii. “N”:- Select N if you do not want the server to automatically create the logs related to the functions of the API. In this case, the user needs to access the server to view and download the logs manually.
|Scope||Click this list and then select one of the following values to define the scope of the API.|
Without Session: – Select this value if you want to execute the API before a session is established at the application level or device level. For instance: – You can use the “Without Session” scope to execute the API before the user authentication.
User Level Session: – Select this value if you want to execute the API after the user session is established.
When a user logs into an app or submits an OTP, the authentication API is called to authorize the user’s details. In this case, the vConnect module creates a user-level token that establishes the user-level session after successful authentication.
Device Level Session: – Select this value if you want to execute the API after the device level session is established.
When a user sends a registration request from a mobile phone device, the request reaches the vConnect module. Thus, vConnect creates a registration token after the device-related data is registered and stored in the database. This device-level token establishes the device-level session. This device-level session lasts until the token exists on the platform.
Note: – You can define the scope of an API with the “User Level Session” or “Device Level Session” options if you want to execute the API after successful authentication.
- After you enter the details of the service, click Save to successfully create the service.