What can be expected?
When the Beekeeper integration is configured, you’ll get the following features.
A link to the MobieTrain app will exist in Beekeeper.
When clicking this link, the user will arrive at the MobieTrain app, already logged in, ready to start the training.
Users will be automatically assigned to User Groups, in MobieTrain, based on the Groups in Beekeeper.
Every day, the system will also look for suspended users in Beekeeper and remove them from the MobieTrain platform. Take into consideration that once a user is deleted, in MobieTrain, it cannot be recovered.
What are the dependencies?
For the integration to work, the client just needs to have an active Beekeeper account and make the right configurations.
Take into consideration that the first and last name are mandatory in MobieTrain, and if these fields are not present, in Beekeeper, the user creation will not work and the integration fails.
What does the client needs to do?
The integration needs to be configured both in Beekeeper and the MobieTrain CMS.
1. Create a Bot Account in Beekeeper
Beekeeper provides a way of integrating its platform with third parties using a Bot Account, which essentially is their way of providing an API key that we will use to authenticate requests to their API.
The steps to create this Bot are described here: Creating Bots
In this scenario, the Bot must be promoted to admin because the used endpoints require admin permissions.
After creating the Bot we should be able to see it listed on the Bot Accounts page:
2. Create a Shortcut in Beekeeper
Beekeeper has a feature named Shortcuts that allows the creation of special links that will be visible in their specific section within the dashboard.
When configuring a shortcut, you can insert placeholders that will be filled in dynamically by Beekeeper. In our case, our shortcut will include the placeholder jwt and userid, so that the users can arrive at MobieTrain already authenticated and ready to go:
http://api.mobietrain.com/beekeeper?token=##{{jwt}}&uid=##{{userid}}
You can then give it the title you wish and even add an icon. We recommend “MobieTrain” for the title, and the following icon:
Here’s the shortcut configuration view:
3. Configure the Beekeeper integration in the MobieTrain CMS
In MobieTrain’s CMS, go to Settings → Integrations. If you have the Beekeeper integration enabled, you’ll find the Beekeeper section that you need to fill:
The Beekeeper URL, is your company URL in the form:
<company>.beekeeper.io
The Beekeeper KEY can be found in the Bot account that you created (you’ll have to hover your mouse over the API Access Token column, to see it and click to copy it):
After the fields are filled in - don’t forget to save - the integration is ready!
F.A.Q.
Are the changes made by a user in MobieTrain reflected in Beekeeper? No. Beekeeper is considered the “source of truth”. For example, if a user changes his name in MobieTrain, this will be overwritten by the information existing in Beekeeper, the next time the user returns to MobieTrain, coming from Beekeeper.
Can I assign Users to User Groups manually? You shouldn’t. That information will be overwritten. Beekeeper is what we consider the source of truth. The user groups coming from Beekeeper will be the ones that will be assigned to the users.