Required role: Super admin.
Generate a bearer token
Every request to the Perform & Engage 365 API requires bearer authentication. Therefore, before you can access the Perform & Engage 365 API, you'll need to generate a bearer token. To generate the token:
1. Select the settings cog icon > API keys. The API Key Management page opens.
This page shows active bearer tokens. Each token has the following columns:
- Username. The username of the API user. Each username is unique.
- Bearer Token. This is a bearer token. Select Click to reveal to view the token.
- Rotate. If there are multiple bearer tokens in the list, you can select the one you're going to use by selecting Rotate.
- Delete. Select the checkbox then Delete Selected to delete the token.
2. Select Generate New to generate a new bearer token.
Send requests via Swagger
You can also use Swagger to access the Perform & Engage 365 API and send requests. To access Swagger:
1. Open the {{your_domain}}.weekly10.net/api/v2/swagger-ui, where the {{your_domain}} is the domain part of your Perform & Engage 365 URL. So, if your Perform & Engage 365 URL is pro.weekly10.net, the URL to Swagger is pro.weekly10.net/api/v2/swagger-ui.
2. The Sign in pop-up screen with the Value field displays. Enter the bearer token you generated via the settings cog icon > API keys and select Sign in.
To send the requests via Swagger:
1. Select the API request.
2. Select Try it out in the top right-hand corner.
3. If needed, enter the query parameters.
4. Select Execute.
5. Go to the Response block to check the results.