Who is this article for?

IT Administrators or Developers who need to authenticate with the Damstra Learning public REST API.

API access and Administrator permissions are required.

This article explains how to generate, use, and regenerate an API access keys for integrating with Ideagen Learning’s public REST API.

1. Generating an API key

To generate an API key:

1. Go to Admin.
2. Select Integration.
3. Click API Access Keys.
4. Click Generate API Key.
5. Copy and store the generated key.

Always store your API key securely and avoid sharing it publicly.

2. Using the API key

To use the API key, include it in the header of your API requests.

The key remains valid indefinitely unless manually regenerated.

3. Regenerating the API key

To regenerate the key:

1. Go to Admin.
2. Select Integration.
3. Click API Access Keys.
4. Click Regenerate API Key.
5. Confirm the action to deactivate the current key and issue a new one.
6. Update all integrations to use the new key immediately.

You can only have one active API key at a time. Regenerating the key will break existing integrations using the old key.