Authentication

Syndicately uses a standard OAuth2.0 authentication flow. In your organization portal you will navigate to the Settings page and then “Manage API Access” screen. From there you will generate your client_id and client_secret. There will also be a callback_url which you will use to get your bearer token and refresh token.

Responses

  • 200 – Token Created Successfully

    bearer_token – String passed to the authorization server to gain access to the system

    refresh_token – String passed to the authorization server to gain access to the system

    token_type – type of token, JWT uses JWT specs

    expires_in – number of seconds the token expires in

    scope – list of scopes that are allowed

  • 400 – Create Token Failure

    errorinvalid_client, invalid_request, invalid_scope, unauthorized_client

  • 429 – Request Failure Due To Rate Limiting

    x-retry-in – how long till you can retry the request (mS)

  • default – Empty Response For Unauthorized or Any Other Status Code

Sample Request Payload

 
{
“client_id”: “string”,
“client_secret”: “string”,
“callback_url”: “string”,
“scope”: “/accounts.write”,
}

Sample Response Payload (200)

 
{
“bearer_token”: “i1qxz68gu50zp4i8ceyxqogmq7y0yienm52351c6…”,
“refresh_token”: “i1qxz68gu50zp4i8ceyxqogmq7y0yienm52351c6…”,
“token_type”: “jwt”,
“expires_in”: 900,
“scope”: “/accounts.write”
}