In this article we will introduce you to how our API works, what are the most common use cases, AD integration and guide you to our documentation.
1. The Claned API
- REST API with JSON or CSV responses
- Can be used for both exports and imports
- Always up to date Swagger documentation for easy experiments and improved developer experience
- Can be integrated with almost any system, assuming the other system can be changed to make calls to Claned’s API
2. Data Flow
3. What can you do with your API?
Most common use cases:
• Invite a new or existing user to a Claned organization or group
• Get course completions and grades and store them in another system
Other use cases:
• Add/remove user roles or access rights
• Remove users from the organization
A) Inviting users
• POST Users/Invite
• Only needs an email address and to what group the user should be added
Optional details:
• When should the user no longer have access
• Some external identifier (ID) that should be included in data exports to identify the user
B) Getting course results
• GET Boards/{boardId}/results
• Only needs a board ID for which course results should be given
• Returns a CSV with users, grades and completion dates
C) Existing AD integration
• Ready-made Azure Active Directory integration for both authentication and authorization
• Authentication = O365 login and automatically add users to organization
• Authorization = Automatically sync groups and their members to Claned from AD
• On-premise AD solutions need to be checked case-by-case
Claned can integrate with your Azure Active Directory tenant with little configuration and no development, so that:
a) your users can log in using their Office365 accounts and
b) Claned can fetch AD group information in real time
The latter is especially convenient, because you only have to maintain information of user-group memberships in your Active Directory, and Claned will automatically sync that information
AD integration requirements:
Claned needs approval to use the user/group information from your AD. This approval is done for your organization’s tenant ID, by someone who has admin rights for your AD instance. Claned has a built-in feature for the approval, which requires the following:
- An admin from your organization to register for Claned
- Enter your tenant ID to our backend. (Otherwise, Claned doesn’t know where the approval should be requested from or on whose authority)
- Approve the request. Done!
4. Example cases
- An insurance organization integrated their Dynamics CRM to automatically invite users to Claned both to train internal staff and customers
- A training company integrated their trainer portal to automatically invite and log in users without having to input credentials
- A governmental training organization integrated their Woocommerce webshop to Claned to automatically invite users after purchase
- A healthcare organization integrated their Sympa HR system to both invite users and return course completion records to the HR system
5. Check out our API documentation for technical details
Swagger interactive API documentation for different instances:
APP: https://api.claned.com/apidocs/index.html
Germany: https://api-germany.claned.com/apidocs/index.html
An example tutorial for integrating with Claned for user invitations is also available upon
request