Welcome to the Synqly API reference!

As an API-first Integration Platform as a Service (IPaaS), Synqly aims to provide a straightforward, unified API to manage integrations from your product. Synqly is designed to be driven programmatically with our REST API.

The API is divided into two main sections:

• Management APIs: for managing objects in Synqly, such as setting up Accounts containers for your customer and creating Integrations to connect to your product to services used by your customers.
• Connector APIs: to interact with the Integrations you have created, such as sending events from your product or collecting asset data from a customer-connected service.

The Synqly API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The concepts behind the API design and use are explained in the Synqly Overview.

Prerequisites

First you must have a Synqly Organization. An Organization is the top-level organizational unit for a Synqly customer. If you do not have a Synqly Organization, sign up using the Synqly Signup page.

Once you have an Organization, to use the API, you need:

• An Organization access Token for authentication.

This token can be generated from the Synqly Console.

Tokens in Synqly grant access to a limited scope of resources. You will use Organization-scoped access tokens to manage objects in Synqly and configure Integrations for your customers, whereas Integration access tokens are used to interact with a Connector API configured for a single one of your customers. Refer to the Authentication section for more information on tokens and their authorization scopes.

Using the API

Synqly will provide SDKs for a number of languages, making it convenient and easy to interact with our API. Our SDKs are the preferred path for integrating with Synqly APIs, as they make it much easier to match types and browse available functionality. If a given language is not yet supported however, it is still possible to communicate with API endpoints directly via HTTPS calls.

Synqly SDK

For a list of all currently supported SDKs, refer to our Synqly SDK guide.

Direct HTTP

If your application is written in a language that does not yet have a Synqly SDK, head to Getting Started with Direct HTTP to learn how to use Synqly via a direct HTTP client such as curl.