Business profile authorization

Authorization as a business profile is the most common authorization when integrating over the API.

Logging in as a business profile

Method reference available here.

When logging in as a business profile, you need a business profile API key.

WARNING: Keep the API keys secret. A leaked key must be deactivated immediately!

Request:

curl --request POST 
  --url https://api.synerise.com/v4/auth/login/profile 
  --header 'accept: application/json' 
  --header 'api-version: 4.4' 
  --header 'content-type: application/json' 
  --data '{"apiKey":"01234abc-1234-5678-9abc-def012345678"}'

The response is a JSON Web Token (JWT) that must be included in the Authorization header of further requests. By default, the token is valid for 60 minutes.

Refreshing JWT

Method reference available here.

When the token is about to expire, you can obtain a new one without logging in again. This is not possible if the token has already expired.

Request:

curl --request GET 
  --url https://api.synerise.com/v4/auth/refresh/profile 
  --header 'accept: application/json' 
  --header 'api-version: 4.4' 
  --header 'content-type: application/json' 
  --header 'authorization: Bearer eyJhbG...JsbSI6ImNsa'

The response is a new token.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.