Documentation Powered by Redocly

AI Search (Nov 27, 2024, 9:34:03 AM)

Download OpenAPI specification:Download

Welcome to Synerise API Reference! We hope that you'll enjoy your stay here.

If you need help with our services, feel free to contact us at support@synerise.com.

Authentication

JWT

Synerise uses JSON Web Token (JWT) as the authorization method. The token is generated by the auth/login endpoint. You need to include it in the Authorization header of your requests, with a Bearer prefix. See this simplified example of a call:

curl -X GET https://api.synerise.com/v4/clients \
-H 'Accept: application/json' \
-H 'Api-Version: 4.4' \
-H 'Authorization: Bearer eyJhbGciOiJSzZXIiLCJjdGQiOjE1NTI0NjMzMjg4NjIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsIm5tZSI' \
-H 'Content-Type: application/json'

Remember to include a space between Bearer and the token.

The token is valid for one hour (unless configured differently). You can request a refreshed key for the session by using the auth/refresh endpoint before the current token expires.

You can verify your JWT signature by using the public key.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

TrackerKey

Authorization by tracker key sent in a token query parameter. This may be the same key as used in the tracking code of the website. For details, see this article: https://help.synerise.com/developers/web/installation-and-configuration/#creating-a-tracking-code.

Security Scheme Type API Key
Query parameter name: token

Authorization

Methods to authorize and obtain JWT token required by our API endpoints

Log in as User

Authenticate as a User.

Note: To perform operations within a Workspace, you must select a Workspace.

  • This method does not require a Synerise authorization token.
Request Body schema: application/json
username
required
string

The login (email address) of the user

password
required
string

The user's password

deviceId
string

Identifier of user's current device

externalProviderToken
string
externalProviderType
string
Value: "GOOGLE"

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "deviceId": "string",
  • "externalProviderToken": "string",
  • "externalProviderType": "GOOGLE"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "token": "string"
}

Verify User multi-factor authentication

Authenticate as a User with multi-factor authentication.

Note: To perform operations within a Workspace, you must select a Workspace.

  • API consumer who can use this method: Synerise User

  • This method is available to all authenticated users, before and after multi-factor authentication is confirmed.

Authorizations:
JWT
    query Parameters
    mfaType
    required
    string
    Enum: "TOTP_AUTHENTICATOR" "EMAIL"

    Type of multi-factor authentication

    Request Body schema: application/json
    verificationCode
    required
    string

    Multi-factor verification code

    deviceId
    string
    externalProviderToken
    string
    externalProviderType
    string
    Value: "GOOGLE"

    Responses

    Request samples

    Content type
    application/json
    {
    • "verificationCode": "string",
    • "deviceId": "string",
    • "externalProviderToken": "string",
    • "externalProviderType": "GOOGLE"
    }

    Response samples

    Content type
    application/json
    {
    • "consumer": {
      },
    • "token": "string"
    }

    Select Workspace

    After logging in as a User, select a Workspace where you want to perform operations.

    • API consumer who can use this method: Synerise User

    • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

    Authorizations:
    JWT
      path Parameters
      businessProfileUUID
      required
      string <uuid>

      UUID of the workspace

      Responses

      Request samples 

      curl --request POST 
  --url https://api.synerise.com/uauth/auth/login/user/profile/%7BbusinessProfileUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

      Response samples

      Content type
      application/json
      {
      • "consumer": {
        },
      • "token": "string"
      }

      Get Workspaces

      Retrieve a list of Workspaces available to the user.

      • API consumer who can use this method: Synerise User

      • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

      Authorizations:
      JWT

        Responses

        Request samples 

        curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/ 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

        Response samples

        Content type
        application/json
        [
        • {
          }
        ]

        Get current Workspace

        Retrieve information about the currently selected workspace.

        • API consumer who can use this method: Synerise User

        • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

        Authorizations:
        JWT

          Responses

          Request samples 

          curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/current 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

          Response samples

          Content type
          application/json
          {
          • "selected": true,
          • "data": {
            }
          }

          Log in as Workspace

          Obtain a new Workspace JWT Token.

          • This method does not require a Synerise authorization token.
          Request Body schema: application/json
          apiKey
          required
          string

          Workspace API key

          WARNING: Workspace API keys can be used to access all customer data and manage the workspace. They should only be used for server-to-server communication in integrations. DO NOT use workspace API keys in your mobile applications or websites.

          Responses

          Request samples

          Content type
          application/json
          {
          • "apiKey": "64c09614-1b2a-42f7-804d-f647243eb1ab"
          }

          Response samples

          Content type
          application/json