Authentication

You've started using the Activate API before July, 1st 2024? Then you're using an older version of the API, which reference documentation can be found here.

Get your credentials

You have to already be a customer of Allo-Media in order to be able to get data from this API. If so, please see with your account manager to get your API credentials. Once you've fetched them, follow the documentation below.

Authenticate and consume the API

Authentication to the Activate API requires a client_id and client_secret, provided by your account manager.

1. Request an access_token by sending a POST request on https://id.uh.live/realms/uhlive/protocol/openid-connect/token with the following payload:

   {
     "client_id": "{the client_id that was provided to you}",
     "client_secret": "{the client_secret that was provided to you}",
     "grant_type": "client_credentials"
   }

   You'll receive a response with an access_token, valid for 5 minutes.

   You can copy this cURL command, and replace your CLIENT_ID and CLIENT_SECRET to get your access token:

   curl -L -X POST 'https://id.uh.live/realms/uhlive/protocol/openid-connect/token' -H 'Content-Type: application/x-www-form-urlencoded' --data-urlencode "client_id=$CLIENT_ID" --data-urlencode 'grant_type=client_credentials' --data-urlencode "client_secret=$CLIENT_SECRET" --data-urlencode 'scope=openid'

2. Pass the access_token in header Authorization with value bearer {access_token} when initiating requesting any HTTP endpoint of the API. For example for the Call list endpoint:

   curl 'https://activate.uh.live/calls' -H 'Content-type: application/json' -H "Authorization: Bearer $ACCESS_TOKEN"