Create an Endpoint¶

To create an endpoint

1. On the Integrations Console, select Design.

2. Select Services (REST/SOAP).

3. On the Services page, click a service against which you want to create an endpoint. An Endpoints list page opens.

4. Click Create Endpoint .

5. Enter the required General Information in the fields as follows:

   a. Name

   b. Description

   c. Category A tag to group together related endpoints.

   d. Connection Test Endpoint toggle If this is enabled, the endpoint will be called to test the connection to the server when a connection is configured using this connection.

6. Click Continue to complete the Authentication.

7. Define the authentication type as one of the following:

   a. Use Service Definition Use the authentication mechanism defined in the service.

   b. None The endpoint does not require any authentication.

   c. Basic The endpoint requires username and password for authentication.

   d. Bearer Token For Bearer type authentication, enter the bearer token. You will get the bearer token from your service provider.

1. Click Continue to fill the Request step details which includes the fields as follows: Go to Request, for more details.

   a. Service URL

   b. Relative URL

   c. Method

   d. Query parameters

   e. Headers

   f. Parameters

   g. Pagination Type

2. Click Call API to invoke the API using the details specified on the request page or click Continue to move to Success Response.

3. The Success Response page is populated if the API call was successful. The page shows the following information:

   Go to Success and Error Response, for more details.

   a. Status

   b. Content Type

   c. Response Body

   d. Output Parameters

4. Click Continue and the Error Response page is populated if the API call was unsuccessful. The page shows the following information.

   a. Status

   a. Content Type

   a. Response Body

   a. Output Parameters

5. Click Save.

   A confirmation message displays: "Endpoint created successfully". You are redirected to the Endpoints list page.

Request¶

Defines an endpoint of the API call.

The request definition contains the following:

• Service URL A URL defined in the service to which the Relative URL is appended.

• Relative URL The value specified for the relative URL is appended to the URL defined in the parent service. Alternatively, an absolute path (beginning with http: or https:) can also be specified in which case the service's URL will be ignored.

• Method This is an HTTP verb. Select one of the methods from below:

  • –GET

  • –POST

  • –PUT

  • –DELETE

  • –PATCH

  • –HEAD

  • –OPTIONS

• Query Parameters URL parameters to pass the API. The value can either be set to a literal value or to a request parameter value, specified as "{$param-name}".

  Click Add a row to add a Parameter and its Value.

• Headers The HTTP headers to set in the request. The value can either be set to a literal value or to a request parameter value, specified as "{$param-name}".

  Click Add a row to add a Header and its Value.

• Parameters The parameters can be used in the URL, headers, or query parameters, specifying the parameter name as "{$param-name}".

  Click Add a row to add the fields as follows:

  • –Name

  • –Description

  • –Value

  • –Label

  • –Type: String/Integer/Boolean/Datetime/Masked

  • –Required toggle

• Pagination Type This specifies a type of pagination. Select one of the pagination types as follows:

  • –None Pagination is not enabled.

  • –Offset For the properties, refer to the following table:

- –Page

For the properties, refer to the below table:

- –Next Page Link

For the properties, refer to the below table:

- –Next Page Token

For the properties, refer to the below table:

JSON Paths

Properties that use JSON paths are as follows:

- Number of Records Path

- Number of Pages Path

- Is Last Path

- Has More Path

- Next Page Link Path

- Next Page Token Path

The syntax for specifying paths for fields in JSON responses follows the JSON Path specification. You can specify the path for the properties as follows:

/key1/key2

For example, given this JSON response:

{

   "token1": "111",

   "object1": { "token2": "222" },

   "array1": [ { "token3": "222" } ]

}

The paths for the three tokens are:

- –Token1: /token1

- –Token2: /object1/token2

- –Token3: /array1/0/token3

Pagination Special Values

In paginated API calls, the pagination parameters are provided either as query parameters, or (less commonly) as request header values. Since these values change with each call to the API, a mechanism is provided to specify these varying parameters.

This is provided by special properties that have the syntax {{…}}. These special values are as follows:

• Call API When the API is called, its response then populates the response body field of either the success or error response, based on the HTTP status returned by the API call.

Success and Error Response¶

Properties for success and error responses are as follows:

• Status The HTTP status code of the response.

• Content type The content type of the response data.

• Response body A response body for a successful/error response.

• Output parameters Output parameters are used in composite endpoints, to pass response values from one API to inputs of a subsequent API. The location allows for extracting parameters from response headers or from the response body. Paths are specified using dot notation, e.g. "address.city", "error.message" Click Add a row to add the Name, Location, and Path.