Connectors provide a secure and type-safe way to access third party REST APIs. Defining a connector requires only a simple file/folder layout that closely maps to the third party's REST structure. Each connector uses a dedicated GIT repository.
Before defining a new connector, double check that one doesn't already exist in our registry. If you develop a new connector, get in touch ‐ we'd love to consider including it in the public registry.
In the root directory, define a manifest file:
name: site24x7.com type: rest-api rest-api: prefix: https://www.site24x7.com/api docs: https://www.site24x7.com/help/api/ token: Zoho-authtoken payload: json accept: application/json; version=2.0
Typically the domain name the connector is for. This name is used for credential keys, and once in production use the name should never change. Using the domain also ensures uniqueness.
prefix will be prepended to all endpoint paths
for this connector.
The name of the token expected in the
to indicate how request content should be encoded and passed to non-GET endpoints.
Accept header expected by the third party API.
The definition of a connector involves mapping folders/files to third party REST endpoints.
Within the update.yaml file specify
Connectors must be imported into the project that will use it.
Define a file in the root named
Within this file specify each imported connector's GIT source
(branch is optional):
Most third party APIs require an authorization token. To pass the authorization token during development builds, see the development credentials JSON format.
The credential key for a connector is
where [connector-name] is the name of rest API's root domain.