Use the connect endpoint to build your seamless Knowledge Hub links when you want to scale quickly and can invest 2+ days in implementation. This method is easy to scale and doesn’t require signature generation for individual links.
Knowledge Hubs are course libraries that help you organize courses by category. To ensure ease of use, Knowledge Hubs support search and priority courses. This allows learners to better understand the context, priorities, and progress.
What's Covered
Embedding links within your app
Why build a Knowledge Hub
Knowledge Hubs are simpler to implement than building links to individual courses. Embed the Knowledge Hub in your application, to provide easy access and encourage continuous learning among your workforce.
Knowledge Hubs are designed to provide learners with an easy way to continue with the content they haven’t finished. Building a rich information repository that learners can access any time results in an empowered workforce, and subsequently leads to reduced need for internal support.
Building your Knowledge Hub
Prerequisites
- You're an eduMe customer with a company admin account.
- You have at least one course and one team created in your eduMe account.
- You've assigned the course to a team.
Procedure
To generate a scalable flow with the connect endpoint you need to get the relevant IDs from eduMe for the:
- Team ID for the team that the learner will be assigned to once they click the seamless link.
You can get these IDs from the admin panel, however this isn’t scalable as each time you want to add a new course or different type of content someone will have to get the ID to the development team to make changes.
We offer a couple of options for you to choose from:
- Webhooks - once set up these can send relevant IDs to your back end. Contact eduMe support for details on how to set up course level webhooks to share teamID data.
- Public APIs - once set up these can request IDs when you need them.
Public API approach
Prerequisites
- You're an eduMe customer with a company admin account.
- You have technical or developer resources.
Generating an API key
- Navigate to the API Keys page in your account using the following link: https://admin.edume.com/settings/developer-tools/api-keys. Alternatively, navigate to Settings in the top bar and choose Company Settings > API Key.
- Select + Create API Key.
- Select the Access level details and choose Create API Key.
You can now copy the API key you've created using the clipboard icon available on the right of the API key.
Public APIs can be used to request different kinds of data from eduMe. For seamless link generation you can call for:
-
Course details. Use the List course API to request course details.
Query parameter Source Group ID Use the Get Group Details with Teams API with the groupId parameter empty -
Team info Use the Get Group Details with Teams API with groupId value in the query parameter
Using the connect endpoint
Generating an API key
- Navigate to the API Keys page in your account using the following link: https://admin.edume.com/settings/developer-tools/api-keys. Alternatively, navigate to Settings in the top bar and choose Company Settings > API Key.
- Select + Create API Key.
- Select the Access level details and choose Create API Key.
You can now copy the API key you've created using the clipboard icon available on the right of the API key.
Generating API request for course links
Use the following connect endpoint to generate course seamless links:
<https://api.edume.com/public/getDashboardLink?teamId={teamId}&externalUserId={externalUserId}>
The query parameters required are:
| Parameter Name | Parameter | Source |
|---|---|---|
| Team ID | teamId | Get Group Details with Teams |
| Course Level Webhooks | ||
| Admin panel (Base link) | ||
| External User ID | externalUserId | Determined by you |
The headers required are:
| Header Name | Header | Source |
|---|---|---|
| X Api Key | x-api-key | Admin panel (Company Settings) |
Branding
You can generate and use seamless links to direct learners to the Knowledge Hub. If you’d like to customize the Knowledge Hub to align with your brand, get in touch with your customer success manager with the following requirements:
- Header colors
- If you’d like to organize course card in To-do and Completed tabs
- The parameter you’d like to sort courses by - Course title or Last published
- Name of the course list
- Border radius
- Brand logo URL
- Style of the course card - with or without an image
Testing
In case of incorrect query parameters, your API request will return errors. If you receive a seamless link in the API response, the link should take you directly to the course.
Contact your customer success manager or our support team if your link does not direct you to the right place.
Embedding links within your app
Embed your Knowledge Hub in an accessible spot in your platform, where learners can quickly locate it. Additionally, we recommend sharing the link through communication tools - such as emails, SMS, in-app notifications - to encourage learners to access the Knowledge Hub.
Native mobile app
Load the seamless link within an in-app browser to enable easy navigation back to your app once the training is complete.
Web app
Load the seamless link within a new browser tab, allowing the user to navigate back to the web app once training is complete.
Related links
Building Knowledge Hubs with Automated Flow Method
Building Knowledge Hub with Proof of Concept Method