/
API Enhancements: More Control, Better Integrations

API Enhancements: More Control, Better Integrations

Overview

We’ve enhanced our API to give you greater control over API keys, improve content completion tracking, and enable smoother integrations with third-party content providers.

Once the integration is set up, learners can search for and discover external content directly within Learn Amp. After selecting the item, they are redirected to the external platform to complete the activity. Once completed, the third-party system automatically sends the completion data back to Learn Amp via the API — creating a seamless and automated tracking experience.

These updates simplify managing 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.

Set up seamless discovery and completion tracking for third-party content

  • Learners can search for external content within Learn Amp and are redirected to the third-party platform to complete the content. Upon completion, the third-party platform sends completion data back to Learn Amp via the API.

  • Automatically hide the “Mark as Complete” button in Learn Amp for externally controlled content, ensuring completions are only recorded when confirmed by the external system.

  • Use unique item identifiers (sourceType and sourceID) to enable reliable linking between Learn Amp and third-party platforms.

  • Manage external content more efficiently via the API by assigning tags and skills (topics) and archiving outdated items, reducing manual configuration.

Access enhanced tracking and auditing for API actions

  • View API key references in Audit logs to track which key was used for specific actions.

  • Find API key references in Activity logs related to completion actions for accurate tracking.

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.

Where can I find documentation?

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

 

FAQ

Your current API key will still work and be visible in the new API key management UI section under Company Settings.

  1. Coordinate with Your Vendor: Reach out to your vendor to plan the integration. Work with them to ensure everything is set up smoothly.

  2. Start in Your Testing & Training Environment: We recommend beginning the integration process in your Testing & Training environment to ensure a safe and controlled setup.

  3. Create API Keys:

    • As an Owner, generate a set of API keys with the necessary permission scopes your vendor will need for the integration.

    • Securely share these credentials with your vendor.

  4. Vendor Integration Testing:

    • Once your vendor has completed the integration, ask them to create a test item via the API in your Testing & Training environment.

    • Test the creation of a completion record in the third-party platform to ensure everything works properly.

    • You can share these instructions with them

  5. Need Help?: If you or your content provider have any questions or run into issues, feel free to raise a support ticket for assistance.

As a user with the Owner role:

  1. Go to Company settings → API / SFTP section

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

  2. Click "Generate New API Key".

  3. 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).

  4. Click "Generate" to create the key.

  5. 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.

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.

Contact Support | Privacy Policy