🔐Authorization
This page describes how to authenticate your requests to Groups API
Important Note! Constructor Groups’ XAPI V1 has been retired and is no longer available to new customers. Please use the Groups V2 API going forward. Link to V2 API documentation: https://developer.perculus.com/v2-en
Below are the parameters required to create ACCESS_TOKEN. This is the token we will use as the Bearer:
DOMAIN: The subdomain of Perculus that is used to access your Panel
ACCESS_KEY: The email address of the user we created for the API
SECRET_KEY: The password of the user we created for the API
ACCOUNT_ID: The GUID of your account
For ACCOUNT_ID data, you can contact your customer success manager and get the ‘ACCOUNT_ID’ belonging to your account.
Use the following example to access ACCESS_TOKEN data.
After sending the following CURL request, ACCESS_TOKEN will be returned as the response.
curl --location --request POST 'https://<DOMAIN>/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'username=<EMAIL>' \
--data-urlencode 'password=<PASSWORD>' \
--data-urlencode 'client_id=api' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'account_id=<ACCOUNT_ID>'
Below you can see a sample response model:
{
"access_token": "<ACCESS_TOKEN>",
"expires_in": 36000,
"token_type": "Bearer",
"scope": "api"
}
The ACCESS_TOKEN will be required for all future services. Therefore, remember to keep your ACCESS_TOKEN in a safe place.
Last updated
Was this helpful?