(Coming soon!) API Enhancements: More Control, Better Integrations

Overview

We've made important updates to our API, giving you more control over API keys, improving content completion tracking, and enhancing integration with third-party content providers. These changes make it easier to manage your external content while ensuring accurate tracking and reporting.

What’s new?

Manage API keys more securely

• Create and manage multiple API keys, each with custom permission settings.

• Assign unique API keys to different vendors instead of sharing one key with full access.

• This functionality is available under Company settings, for users with Owner role.

Leverage new API capabilities for Content management

• Tags and topics can be assigned when creating or updating items.

• The uniqueness of Source IDs is ensured for newly created items.

• Outdated content can be archived.

Report on content completion from third-party platforms directly in Learn Amp

• Completion tracking can now be centralised in Learn Amp, reducing the need to check multiple systems.

• Third-party platforms can send item completion into Learn Amp directly through the API.

• A new setting hides the "Mark as Complete" button for items where completion is controlled externally.

• This ensures content completion is only recorded when the external platform confirms it.

Access enhanced tracking and auditing for API actions

• The API key reference is added to relevant Audit log actions.

• The API key reference is added to relevant Activity log completion actions.

• This allows for better tracking and accountability.

How will this benefit you?

✅ More control over API access and security.
✅ Accurate tracking of content completion, with fewer manual actions.
✅ Easier management of external content directly through the API.
✅ Improved transparency with better logging of API activity.

How can I get started?

• These updates will be available to all customers as soon as they are released:

  • Metadata capture for tags and topics on Create an Item and Update an Item endpoints

  • Content archiving via API

  • Enhanced auditing for API actions

• These improvements will be released as a Beta feature:

  • Create items with externally controlled completion parameter.

  • Create completion records from third-party platforms.

  • Create and manage multiple API keys with granular permissions.

Where can I find documentation on these features?

Our API documentation can be found here: https://developers.learnamp.com/#api-reference.
Please check the following sections for the specific updates:

• Create an Item endpoint

• Update an Item endpoint

• Complete an Item endpoint

For the features released in Beta, please check out the section below for more detailed instructions.

BETA features

How can I create new API keys with granular permissions?

As a user with the Owner role:

1. Go to our Beta features section to enable the feature: “API Enhancements: More control & Better integrations”

2. Then, go to Company settings → API / SFTP section

   1. If SFTP is not set up for your account, look for the API section.

3. Click "Generate New API Key".

4. A modal will prompt you to:

   • Assign a key name (must be unique).

   • Set permissions:

     • Full access (to all API endpoints).

     • Custom defined (e.g., Read, Create, Update, Delete, Complete an Item).

5. Click "Generate" to create the key.

6. The new key appears in the table view, where you can:

   • View and copy Client ID and Client Secret information.

   • Regenerate, or delete the key.

🔹 Remember: Securely store API credentials once copied.

How can I create items with externally controlled completion and send completion records via API?

Step 1: Create an item with externally controlled completion

1. Ensure the API key used has permission to “Create” Items.

2. Set "externallyControlledCompletion": true in the API request.

   • This hides the "Mark Complete" button on the item page for Learners.

   • Admins and Owners can still mark items as complete on behalf of Learners.

3. Use "sourceID" and "sourceType" parameters to store an external identifier associated to this item.

Step 2: Send a completion record from a third-party platform to Learn Amp

1. Ensure the API key used has permission to “Complete” Items.

2. In the Complete an Item request:

   • Ensure "sourceID" and "sourceType" match the ones assigned to the previously created item.

   • Include an identifier for the user (e.g., "userId" or "email").

3. Once successful:

   • A completion record appears in the Activity log, showing the API key reference.

   • The item is marked as complete for that user.

🚨 Items must be created via API with "externallyControlledCompletion": true to allow completion through an API request.

These enhancements are designed to improve how you manage external content and integrations—helping you work more efficiently and securely. 🚀

FAQ