Client Management (Sep 29, 2020 1:28:06 PM)

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.

To open Synerise's Client Management category collection in Postman, click here

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

apiKey

Authorization by API key sent in an X-Api-Key header. Remember to use an API key with the consumer scope and permissions appropriate for the endpoint you're using.

Security Scheme Type API Key
Header parameter name: X-Api-Key

Authorization

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

Refresh a Business Profile token

Retrieve a refreshed JWT Token to prolong the Business Profile session.

  • API consumer who can use this method: Business Profile
  • This method does not require a Synerise authorization token.
Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"
Api-Version
required
string
Value: "4.4"

Responses

200

New authorization token

401

Unauthorized

get /auth/refresh/profile
https://api.synerise.com/v4/auth/refresh/profile

Request samples

Copy
curl --request GET 
  --url https://api.synerise.com/v4/auth/refresh/profile 
  --header 'Api-Version: SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyinvalidQSSIsInJsbSI6ImJ1c2luZXNzX3Byb2ZpbGUiLCJjdGQiOjE1NTMwMDM5OTA0MTUsImF1dGgiOiJINHNJQUFBQUFBQUFBSXNPY25YMDhZMTM5dkYwOVF1SmQzUjI5Zy8xQzlGUlFCYUY4VnpEa0RnaFFZNSt3WTdPSVo3K2ZyRUFHdGRoUWtRQUFBQT0iLCJpc3MiOiJTeW5lcmlzZSIsImJwaSI6NDgsImV4cCI6MTU1MzAwNzU5MCwiYXBrIjoiOTEzODE5OTMtRDlFQy04MEIxLUIwMzMtOTExMjNDRENFRjFDIn0.Y1u4RgHiinvalidTXPWlkaFW_ZyoFrdEo1WeFs1FGpmGs6FW3fQbulBZC0R5kr_U3-1K7i1Ts9vTbMdmesyfI_wGMwIrxK2wd7_LU5wMR6W8ppoZJ8a8CzNiWJQAn7yB0Zis2rsnvvM-YLBAILt6xKkfPcUMkbLqP_Iz8VwGDmMwSN6zBYqzu_m0CpJ15YWiOpYkWcoDPYkGSsWBPM"
}

Log in as Business Profile

Obtain a new Business Profile JWT Token.

  • This method does not require a Synerise authorization token.
header Parameters
Api-Version
required
string
Value: "4.4"
Request Body schema: application/json
apiKey
required
string

Business Profile API key

Responses

200

Business Profile authorization token

401

Unauthorized

post /auth/login/profile
https://api.synerise.com/v4/auth/login/profile

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "apiKey": "91381993-D9Einvalid91123CDCEF1C"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxinvalidGUiLCJjdGQiOjE1NTMwMDQ3Mzk2NTUsImF1dGgiOiJINHNJQUFBQUFBQUFBSXNPY25YMDhZMTM5dkYwOVF1SmQzUjI5Zy8xQzlGUlFCYUY4VnpEainvaliddGRoUWtRQUFBQT0iLCJpc3MiOiJTeW5lcmlzZSIsImJwaSI6NDgsImV4cCI6MTU1MzAwODMzOSwiYXBrIjoiOTEzODE5OTMtRDlFQy04MEIxLUIwMzMtOTExMjNDRENFRjFDIn0.dllaEzYPDXqWPLLUOAUwHOpYLc4-Aj_vkBZb3e7kPo6FZYw5fEAqaoFG1sUoz0HYETJqZ_30UnYBwhbM6qhXGiuoNDiO3f5V0NVSP9DObq_rAtx4FdPtvfjaMXdFkzlTVK8GZSCRJU9Jtvm5_G-KR5hmCOOnJFeU68LJuVtnK2TikRg2v1rhyKODjpcCY9mvPoVrDheOKRE-XGAONSnz2lHMrFpDffhrR-Ten5hu0Z10oUUO5cr0CMinvalidyiejsbYaoQx-XdI8Gys2SpmCtcOnTySs1M3tX6Gdv5QjASYIm32fTPEm82X9dPWYGQO4UG79vwr9kaXzIBVB_iJs9TazTnIrIkbWgqUNQ17bSe6MVBqwmlzv_NxCaSvKAbYqe9FLxcuSGXXUamNdMkwB3Kf1BLs1JTWhBZJXPUSS2eJBcPCxoiTMKu2jNR7cnlRf4iBdzOE60j5aynn1D68HZ1BnZcq_mGYtEJLK3mShtypcFy3kGaWN76uedPwVNH-OFYZeNacb1qxCkNmaJPE71hiP5nUiXmB_AlgkHZA5C7F3iB4i_SruqECEBTMnLjj0TRih7BUdadjI16We-5AKWYlk1YTN3jSKXdnHc0Ht7Ok6xLPr7Zk5v8xEiWY0dDE31CJCtzME7nGnn8KGRIZFkwT1bm4"
}

Authenticate as Client

Obtain a new Client JWT Token.

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

Client API key

email
required
string

Client e-mail

password
required
string

Client password

uuid
required
string

UUID of the Client

deviceId
string

Important: deviceId is required during login if device control is enabled.

Responses

200

Client authorization token

401

Unauthorized

post /auth/login/client
https://api.synerise.com/sauth/auth/login/client

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "apiKey": "5AEAA3D5-E147-C7EB-invalid50109A3D1",
  • "email": "testDoc@example.com",
  • "password": "testPass1!",
  • "uuid": "b3f56868-9667-4843-a8e5-0509456baa9b"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Authenticate anonymously

Obtain a new JWT for an anonymous Client (without an existing Client profile). The token can be used and refreshed in the same way as tokens of registered Clients.

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

Client API key (same as for Client login)

deviceId
string

Unique Android or iOS device ID

uuid
required
string

UUID of the Client

Responses

200

Anonymous authorization token

401

Unauthorized

post /auth/login/client/anonymous
https://api.synerise.com/sauth/auth/login/client/anonymous

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "apiKey": "string",
  • "deviceId": "string",
  • "uuid": "07243772-008a-42e1-ba37-c3807cebde8f"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Authenticate with Facebook

Use a Facebook token to obtain a Client JWT Token. If a Facebook account is logging on for the first time, a Client account in Synerise is created.

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

Facebook authentication token

apiKey
required
string

Client API key (same as for Client login)

uuid
required
string

UUID of the Client

deviceId
string

Unique Android or iOS device ID

agreements
object

This object