Describe Third Party System's API

After registering a new connector, sample JSON Specification will be pre-filled. In this page we'll explain how the authentication, the API paths and the object schemas of the third party system API must be defined.

The definition is a JSON format document following the OpenAPI-Specification (v3) Standard.


Basic Information


Basic information  like title, contact name and version  need to be set according to the specification.


In order to validate the JSON at any point the Validate button can be used.

Server


Developer can set as many servers as he wants. Server object contains the following items:

  • Description: A brief description
  • URL: The API base URL. The URL can contain a dynamic variable as well by using {VariableName} tag
  • Variables: Can be used for replacing a dynamic variable on the base API URL or for using a static value in the transformation. Variables must contain a brief description and the default value of the variable which can be overridden at any time from the settings page.

Security Schemes


At least one security scheme must be set in this tab. In order for the security scheme to apply in API calls, it must be set in the security tab  according to the specification.

Paths


This tab contains all the API paths that will be used for the integration. Path must meet the specification requirements.  

Every path object define what content type and component schema will be used for each REST method.

Paths can also contain dynamic variables by using {VariableName} tag (i.e most of APIs in order to update an entity they require the ID of the entity to be present in the  request URL). During synchronization this will be automatically replaced with the value of the "VariableName" found in the object that will be synced.

Every create/update/delete/read/batchRead path that will be used in the synchronization tab must be set in this path object.

Schemas Objects


For each object that will be synced, the appropriate schema must be set according to the specification, in the schema tab.

Table of Contents




You can proceed by learning how to define the data transformation schemas Next