Service Details

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:

1. On the home page of the vConnect module, find the Service Management tab.

2. Click the Service Management tab, and then click Add New Service, and the Service Details page opens with the selected Service Details tab.
3. On the Service Details page, enter the details of a new service as follows:

Box/List	Description
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.
Log Purge Days	This property allows you to define the number of days after which the vConnect module will purge the logs at the application level.
Response Type	Click this list and then select one of the following values: 1. JSON:- Select this value to receive the response in JSON format. 2. MULTIPART:- Select this value to receive the response in multipart HTTP format. The multipart response combines different data sets into a single body. These data sets are separated by the boundary. 3. Callback:- Select this option to enable the callback mechanism. When a client sends an API request with the callback mechanism, it sends a callback URL string with the request data. After the server receives the request, it instantly returns an acknowledgement to the client. After the actual response is received, the server sends an event-based notification to the callback URL so that it can return the response. The callback feature improves the API’s workflow.
Transform HTTP Code	This property allows you to define a new status code (response code) in place of the currently used status code. To define a new code: 1. Click Transform HTTP Code, and the Transform Http Code dialog box opens. 2. In the Transform Http Code dialog box, in the Response field, enter the currently used code (for example, 204). 3. In the Transform field, enter the new code (for example, 202) that will replace the currently used code. 4. To replace other currently used codes, click Add New, and then perform steps 2 and 3. 5. After you define the new Http code, click Save to configure the new code.
Sample Object	In the Sample Object area, you can see two boxes as follows: 1. Request 2. Response In the Request box, you can enter or copy-paste a sample request code when you configure an API. Or, if a service contains multiple APIs, the service can fetch and display a request in the Request box from a recently generated logs. If the service is running, it will automatically display the response in JSON format in the Response box on the basis of the sample request.
Upload Documents	This property allows you to upload a support document that can help you provide the additional information to the user. You can use this feature when you want to provide additional information about API, such as parameter details, the list of associated response codes, sample requests, and response data for success and failure. Later, you can delete or download the earlier uploaded file.

4. After you enter details of the service, click Save to successfully create the service.