You can interact with the Universal and Platform APIs through the access token authorization. To generate the access token you should first call /api/auth endpoint and authenticate. To get params for the auth endpoint, please register an account in the UAPI Portal https://portal.prod.universalapi.io and get your own API Key, Application ID, Consumer ID. You can find your API key on the credentials page, your Application ID on the dashboard page, your Consumer ID can be found on the consumer page.

Before making Universal and Connection APIs requests you should authenticate your consumer first. Call the authentication endpoint with apiKey and consumerId and scope: consumer to get an access token.

Before making Consumer and Webhook APIs requests you should authenticate your application first. Call the authentication endpoint with apiKey and applicationId and scope: application to get an access token.

Authorize your API requests by including your access token (returned by the authentication endpoint) in the request header:

  • Bearer authorization header: Authorization: Bearer <your-access-token>

Do not share or include your API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.