Getting Started

The Synap API is currently in beta. Expect some instability, incomplete documentation and potentially breaking-changes.

This documentation covers the Synap API endpoints and use-cases.

Looking for our legacy "Org API" documentation? Please click here.

Looking for the "Synap Academy" Help Guides? Please click here.

Looking to extend or customise your organisation's Synap platform experience? You've found the right place. Please read on.

API Design

The Synap API is built upon two well-known industry standards:

OpenAPI v3: Specification

JSON:API v1.1: Specification

You do not need to be familiar with either of these standards to begin building with the Synap API. However, any client libraries you wish to use to interact with the API can safely assume that the requests and responses will adhere to these standards.

First Request

You do not need an organisation-level "secret" API Key to access the Synap API. Instead, we have opted for a self-managed token approach called Personal Access Tokens (PATs). Once obtained, you add this to each request as an Authorization: Bearer <token>. Read the Authentication guide to learn more.

Once you have obtained a PAT, here is a simple CURL request that you can try:

If you see some data related to your organisation's Portal, the request was successful:

{ "data": {"type":"Portal", "id":"...", "attributes": { ... }} }

Otherwise, if your PAT was invalid or misconfigured, you may see the following:

{ "errors": [{"status":"404","title":"...","detail":"..." }] }

Testing

You may wish to build your integration against our "Staging" API. However, as this API will be unable to access your organisation's "live" data, we must first setup a staging environment for you. This is currently only available to our Enterprise customers. Please get in touch if your organisation needs this functionality.

API Design#

First Request#

Testing#

API Design

First Request

Testing