In short
In Continuum Learn, team admins create API keys in Settings > Website & API > API keys. Each key has a name, the scopes you tick and an optional expiry date. It is shown once, and you can revoke it at any time.
Still deciding? See what LMS API in Continuum Learn can do for your organisation.
An API key lets another system, such as your membership database, intranet or website, work with your Continuum Learn team through the Continuum Learn API. Your developer or supplier will usually ask you for one. This guide is for the admin who creates it.
Who can do this: team admins. API keys are on Settings > Website & API.
Before you start
Ask whoever is building the integration two things:
- What it is for, so you can name the key after it, for example "Membership system sync".
- Which scopes it needs. A scope is one kind of access, such as reading courses or enrolling learners. Give a key only the scopes it needs. The developer documentation lists which scope each part of the API needs.
Plan one key per system. Then if you stop using one system, you can revoke its key without breaking the others.
Create a key
- Go to Settings > Website & API.
- In the API keys card, click Create API key.
- Enter a Name that says what will use the key.
- Under Scopes, tick each kind of access the key needs (see the table below).
- Optionally, set an Expiry date. The key stops working at the end of that day. Use this for a short project or a contractor.
- Click Create key.
- The key is shown once, in the Your new API key window. Click Copy and pass it to your developer through a secure route, such as your password manager. Don't send it in an ordinary email or chat message.
- Click I've copied it.
You won't see the key again: Continuum keeps only a scrambled version (a hash) that can check a key but can't show it. If the key is lost, revoke it and create another.
Scopes
| Scope | Gives access to |
|---|---|
catalogue:read |
Read the course and event catalogue, including private courses |
users:read |
Read users, your sign-up fields, groups and group members |
users:write |
Create and update users, and deactivate or remove them from the team |
groups:write |
Create, update and delete groups and their members |
enrolments:read |
Read who is enrolled on what |
enrolments:write |
Enrol people on courses and remove enrolments |
progress:read |
Read learners' progress, quiz results, attendance and certificates |
webhooks:manage |
Set up webhooks that send events to another system |
auth:sign_in_links |
Create one-time links that sign a learner in from another system |
credentials:read |
Read the credentials (certificates and badges) you have issued |
orders:read |
Read completed orders, invoices and credit notes |
A few things to know before you tick the write scopes:
- Enrolling through the API takes no payment and skips approval. A system with
enrolments:writecan enrol people on paid courses, and on courses that need approval, straight away. - The API never makes anyone an admin. People it creates are always learners, and it can't change admins, owners, billing contacts or authors, or anyone who also belongs to another Continuum team.
- Sign-in links are powerful. A key with
auth:sign_in_linkscan sign learners in. Only give it to a system that already checks who people are.
See and revoke keys
The API keys card lists every key with its name, the first characters of the key (so you can tell keys apart), its scopes, when it was created, when it was last used and its status: active, expired or revoked.
To revoke a key, click Revoke next to it. It stops working straight away, and whatever uses it gets an "authentication" error on its next request. Revoking can't be undone; create a new key if you need one.
You can't change a key's scopes after creating it. To change them, create a new key with the right scopes, have your developer switch to it, then revoke the old one.
The older team API key (v1)
Below API keys is the Team API key (v1, legacy) card. This single shared key is used by the WordPress plugin and by integrations built before API keys existed. It doesn't work with the current API (v2), and new integrations should use a key from the API keys card instead.
Clicking Rotate API Key replaces the legacy key immediately, which disconnects any WordPress site or integration still using it until it is updated. Sites connected to the WordPress plugin with their own credentials are not affected. See How to connect a WordPress site to Continuum Learn.
Keeping keys safe
- Treat a key like a password: anyone who has it can do what its scopes allow.
- Keys belong on servers. They should never be put in a web page, a mobile app or a shared document.
- Revoke a key as soon as the system or person using it no longer needs it, or if you think it may have leaked.
- Check Last used from time to time. A key that hasn't been used for months is probably safe to revoke.
Frequently asked questions
Does the API cost extra?
No. The API is included on every Continuum Learn plan.
Can a key see other teams?
No. A key belongs to one team and can only ever see that team's courses, people and progress.
Our developer says they get "permission_error". What does that mean?
The key doesn't have the scope that part of the API needs. Create a new key with the extra scope, then revoke the old one.
Where is the technical documentation?
In the developer documentation, starting with Getting started. It includes an API reference your developer can import into tools such as Postman.