After registering a new connector, the sample JSON Specification will be pre-filled. This page shows 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.
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md
Basic Information
Basic information like title, contact name and version must be set according to the specification.
In order to validate the JSON at any point, select Validate.
Server
There is no limit to the amount of servers developers can set. The 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 the {VariableName} tag
- Variables: Can be used to replace a dynamic variable on the base API URL or to use 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. For the security scheme to apply to API calls, it must be set in the security tab, based on the specification.
Paths
This tab contains all the API paths that will be used for the integration. The path must meet the specification requirements.
Every path object defines which content type and component schema will be used for each REST method.
Paths can also contain dynamic variables with the {VariableName} tag (i.e., For most APIs, it is required that the ID of an entity is in the request URL so it can be updated. During synchronization, this will be automatically replaced with the value of the VariableName found in the object which 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 based on the specification, in the schema tab.
