Category: Configuring End Point Details

This feature allows you to configure DB (Database) APIs. The DB APIs are the database store procedures or functions. These store procedure and functions contain a SQL statement that connects with the database and returns the result. To create a DB API, you access a database client such as Oracle, MYSQL, or Postgres SQL. In… Continue reading Database

In the API Management module, this feature allows you to define the parameters that the API request’s header section contains. The header parameters are used for authentication purposes. The header parameters provide complete information about the source of the API request. While integrating an API with the vConnect module, configuring header details is not a… Continue reading Configuring End Point Header Details

You perform this activity several times. When you configure multi-part parameters, template body parameters, or query and path parameters, you select the source of value. The source of value specifies the source location from where the vConnect module fetches the data. Based on the source of value, you configure the API parameters and determine the… Continue reading Selecting Source of Value

The query parameters are appended as an optional key-value pair to the URL string. In the URL string, the query parameters are used to determine the location of a specific resource. The query parameters are appended to the URL string after the question mark character (?). In the query parameter, multiple parameters separated by the… Continue reading Configuring Dynamic Query Variables

This feature allows you to configure the path parameters in the API request. The path parameters are part of the end-point URL and point to a specific resource. They are enclosed by curly braces {}. For instance: – If you want to find a specific resource based on its ID, you can use the path… Continue reading Configuring Dynamic Path Variables

You can use this feature when you want to define the body of the API request. When you want to get the data from the server, you issue the API request in the form of a URL string. The Get-type request does not have a request body. When you want to update or create data… Continue reading Mapping Template Body Parameters

This feature allows you to establish the connection with the end point via proxy-based authentication mechanism. To configure the usage of API via proxy:

The timeout properties are configured in “Seconds” (unit of time). If the API execution exceeds the timeout value, the API will show the error. To configure the timeout properties:

To configure the request type and the method: Box/List Description Name In this box, enter the name of the parameter that you have defined in the code of the API or in the end-point URL. Note:- If the name of the parameter in the Name box does not match the parameter that you have defined… Continue reading Configuring Request Type and Method (Mandatory Step)

In the vConnect module, this function allows you to determine the data format that the vConnect module receives from the front-end application. Based on the data format of the request, you determine if the data conversion is required. The vConnect module, as a software application service, understands data in the JSON format. It only receives,… Continue reading Request Transformation (Mandatory Step)