Introduction

Welcome to Synqly! Our platform provides a simple, secure, and sustainable interface for integrating with third-party platforms, enabling you to connect once and immediately give your users access to multiple services. Synqly implements unified API that translates requests and responses from our model to supported third-party APIs and services.

Key Concepts and Data

Understanding this terminology will help ensure you have a smooth setup process with Synqly.

Concepts

• Connector: A unified API and data model for each category of providers (e.g., Messaging, Ticketing, Storage). connectors offer a single interface for multiple providers in the same category.
• Provider: A specific third-party service within a connector, such as Jira or ServiceNow within the ticketing connector. Synqly translates your requests to interact with many providers using a standardized model.
• Tenant: Your customer who can access Synqly's API via an "account".
• End User: The customer of your customer, someone who registers integrations (e.g., connecting Jira to Synqly).

Data

• Organization: The top-level unit for managing your Synqly integration. An organization allows you to manage multiple accounts. Synqly customers typically run multi-tenant applications, with each tenant supporting many end users.
• Member: A member of the organization. Depending on a member's permission they can modify data such as the organization it self, accounts, and all of the accounts data.
• Account: An account under your organization dedicated to managing data for a single tenant. Resources for accounts are segregated to ensure data privacy.
• Integration Point: It acts as an allow/deny list of available providers for your end users to setup. Integration points help you control your product's integrations by providing additional features and configuration.
• Integration: The connection to a provider, set up via Synqly Connect or Synqly's API/SDK. Once configured, an integration enables interaction with the target provider via Synqly's Connector APIs. Each integration belongs to an account and can be associated with an integration point to provide additional features and configuration.

Synqly API Model

All communication with the Synqly API requires authentication, and this is done with bearer tokens. These tokens are restricted to work with a minimal set of API resources. For more information on Tokens, refer to Authentication.

Each of your tenants is represented as an account in Synqly. We recommend that for each of your tenants your backend should create one account in Synqly using the Accounts API. You may create more than one account per tenant, but unless you have a need for the added security we recommend keeping it to one.

Data is segregated to prevent any crossover between accounts or organizations . You may also create accounts for internal use such as for testing, staging, and sales purposes. Each account has a unique ID.

Each account can contain many integration objects, each of which encapsulates a connection to a provider. Once configured, an integration lets you use the relevant Synqly connector API to send requests to the target provider. For example, after creating an integration using the Jira provider, you may use the Ticketing API to create, update, and delete Jira issues.

Getting Started

1. Create an Organization:

   • Navigate to our Synqly Signup page.
   • Fill in the form and click "Create Account."
   • Synqly will provision an organization.

2. Save Your Access Token and Organization ID:

   • After creating your account, the browser will display your organization access token and organization ID.
   • Save the Token, as this is the only time it will be shown in the UI!

3. Explore Synqly's APIs:

   • With your organization ID and access token, you can try out Synqly's APIs.
   • Use either the provided SDKs or direct HTTP calls.
   • Some API calls require spesific tokens. Check out the Authentication docs for more info.

Next Steps

Select which interface you want to use, SDK or HTTP. The SDK is the preferred method to interact with 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.