This guide will walk you through the process of creating an API key and integrating Learningbank with other systems. It's a straightforward process that can significantly enhance your learning management capabilities.
We offer an easy integration method for most systems that doesn't require a custom API key. Check out our Integration Hub to see if your desired system is listed. If it is, you can skip ahead to the linked help center article for specific instructions.
However, for systems like Ziik or Tamigo, you will need to create a custom API key using the steps outlined in this guide. Continue reading this article to learn how to create a custom API key and integrate your chosen system with Learningbank.
For a more comprehensive understanding of integration terminology, we recommend referring to our dedicated help center article Integration Terminology. This will ensure a smoother and more informed reading experience for this guide.
API keys can be used by developers to connect other APIs, allowing for integrated cross-application exchange of data and functionality.
API authentication may sound intimidating, but it's actually quite simple to implement.
Access the Integration Hub
Log in to your Learningbank platform with an administrator account and make sure you're in Administrator view.
If you are not able to see the Integrations menu item, contact our support ([email protected]).
Creating a New API Key
Now that you're inside the integration hub, the magic can start to happen. Before you create the API key, browse to see if you integration is already in out Integration Hub.
If not, you navigate to the top right corner and click Go to API Keys.
Generating a New API Key
Now click + on the right on the API Keys lane, to create a new API key.
Give the the API Key a relevant name and description. The name is only relevant for your own organizational overview, if you have multiple integrations at some point. We also recommend giving it a description, that explains briefly what the key is used for, to help with future overview and understanding.
We recommend you type the name of the system you wish to integrate with.
Click save.
Obtaining Your API Key
Now you should see that you've created a new API key with the name you wrote.
Underneath the name you should see:
Token
Password
All of this is automatically generated for you, and you actually only have to now copy the Username and Password in order continue.
Simple right? 👏
🪄 Volia! Once you've saved your credentials, you can now share the "Username," "Token," and "Password" with the provider who should set up your connection with Learningbank.
Handling User Inclusion and Exclusion with Custom User Integrations
If the key is not used for a user integration, you can simply ignore this.
If the API key is used for a custom user integration, we recommend taking a look at the following article, which explains how users can be included or excluded:
This can be useful for ensuring that admins or users who need to be handled separately are not overwritten by the integration.
To access the include and exclude settings, simply go to the Integration Hub, under API Keys and click on your key:
Once opened, you can now add users, departments, job profiles or permissions to be included or excluded from the user integration, by adding them on the individual tab.
📣IMPORTANT:
Including and excluding users with the API key only works if the key is used with certain partner systems, or with our upsert or sync endpoint:
The feature also works, if you have a custom user integration build and maintained by Learningbank.
Any other setup does not support this feature.
If you are unsure whether your setup supports it, please reach out to our support team.