This article contains a description of the Cloud Academy 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 Cloud Academy API
The Cloud Academy API is a programming interface that you can use to integrate Cloud Academy features with your internal business systems. For example, you might use the Cloud Academy 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 Cloud Academy 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.
Generating an Authentication Token
Like most APIs, the Cloud Academy API requires you to use an API key pair (a client ID value and a client secret value) to generate an authentication token. Using the token, you can retrieve the data from the correct account and authenticate that your user is allowed to access the information.
An admin user of your enterprise account can generate the API key pair from the management dashboard. Then, the developer uses the key pair to generate a token. Each admin user has a distinct API key pair and can generate a new key pair at any time. Generating a new key pair revokes access to the old key pair, so it is a good way to remove access to the account information.
Important: If an admin generates a new API key pair while the old key pair is still being used by existing integration code, your integration will stop working until you update the key pair values in the code.
Use the following steps to generate an API key pair:
- From the dashboard, click the Manage your company link. The management dashboard appears.
- Choose Settings & Integrations from the menu on the left. The Settings & Integrations screen appears.
- Click the API tab.
- Click Generate new keys. The system generates a Client ID and Client Secret and shows them on the screen.
- Use the client ID and Client Secret in your code to generate an authentication token. The token lasts for 10 hours.
What's Next
You can find a list of available API calls in the Cloud Academy API technical documentation here:
https://cloudacademy.com/restapi/docs/swagger/