Generate API keys and access the Perform & Engage 365 API

Required role: Super admin.

Generate API keys

Before you can access the Perform & Engage 365 API, you'll need to generate the API keys. To generate the API keys:

1. Select the settings cog icon > API keys. The API Key Management page opens.

This page shows active API keys. Each API key has three columns:

• Username. The username of the API user. Each username is unique.
• API Key. This is a password. Select Click to reveal to view the API key.
• Delete. Select the checkbox then Delete Selected to delete the API key.  

2. Select Generate New to generate a new API key.

Every request to the Perform & Engage 365 API requires the Authorization header that uses the HTTP Basic Authentication. Use the Username and API key from the cog icon > API keys to Base64-encode the credentials and generate the header.

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 {{region}}.weekly10.net/api/v2/swagger-ui, where the {{region}} is the regional 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 Username and Password field displays. Enter the credentials 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.