Workspace authorization

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

Logging in as a workspace

Method reference available here.

When logging in as a workspace, you need a workspace API key.

WARNING:
  • Keep the API keys secret. A leaked key must be deactivated immediately!
  • When creating the API key, use allowlisting or denylisting to only allow the events you intend to use.

Request:

curl --request POST 
  --url https://{SYNERISE_API_BASE_PATH}/uauth/v2/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.

😕

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.

Close modal icon Placeholder alt for modal to satisfy link checker