This article contains a description of the QA API, instructions for generating an authentication token, and links to the documentation of the API calls. You must have an enterprise account to use this feature.

This article contains the following sections:

• What Is the QA API
• Generating an Authentication Token
• Throttle Limit
• What's Next

What Is the QA API

The QA API is a programming interface that you can use to integrate QA features with your internal business systems. For example, you might use the QA API to create a custom dashboard that's available from your company intranet.

The API contains calls to let you do things like:

• Access the QA library
• Retrieve user progress or company progress by user
• Manage teams

See the documentation of the API calls (link below) for a complete list of what you can do with the API.

API Documentation in Swagger

QA uses Swagger to create documentation of each element of the API. You can find the Swagger site here:
https://cloudacademy.com/restapi/docs/swagger/

In addition to describing each element in the API, Swagger also includes a tool to "try out" each call, as you see in the image below.

Tip: To avoid Unauthorized errors, don't forget to click the Authorize button above the Filter by tag field near the top of the screen before using the Try it out feature. 

Generating an Authentication Token

Like most APIs, the QA API requires you to use an API key pair (a client ID value and a client secret value) to generate an authentication token. The API key pair is specific to each admin user in your account. The token you generate lasts for 10 hours.

See Generating an Authentication Token for details about the authentication token.

Throttle Limit

QA does throttle API calls to protect performance at the application level. The current limit for the public API is 100 calls per minute.

Note: Some endpoints, such as those related to the Reports API, may have more restrictive throttling.