đ˘ The API service offered by Didask allows you to securely open platform data, enabling your external systems (LMS, website) to exchange information with Didask. This interconnectivity simplifies processes, saving time and increasing efficiency for your development teams.
1/ What is an API?
An API is like a waiter in a restaurant. It allows you to interact with the kitchen without stepping inside or needing to understand the intricacies of cooking.
The waiter presents you with a menu: This represents what the kitchen can prepare for you.
You place an order: You indicate what youâd like to eat.
The waiter delivers your dish: You receive exactly what you requested.
In this analogy:
The menu represents the list of possible actions with the API.
Placing an order is whatâs known as "consuming an API."
The dish the waiter delivers is the APIâs response.
â
đ Why use an API?
For the same reasons you rely on a waiter:
It keeps you out of the kitchen, avoiding any mess you might create.
The waiter tells you whatâs available to order, saving you from guessing in front of the fridge or oven.
đ What about the Didask API?
The Didask API allows you to perform several operations within the Didask platform. The âmenuâ includes the following:
Simplified user access
Enable Didask users to open the application directly from your LMS with seamless authentication.
Learning analytics integration
Retrieve learning data from Didask to merge with your LMS, including:User identity
Groups
Accessible publications
Started publications
Completed publications
Completion percentage
Automate actions in Didask
Based on data from a third-party system, you can:Create a new user
Create a group
Add a user to a group
Display real-time data on your website
For example, the API can display the number of learners who have completed a training session.
đ How does it work?
đ You will need developers to set up the API.
To learn how your system can integrate with Didask, we recommend sharing the following documentation with your technical team: Didask API Documentation
2/ What are connectors?
Now that you understand APIs, letâs dive into connectors.
Imagine youâre dining at a restaurant in India but donât speak the local language. The waiter doesnât speak French either. To order your meal, you use a friend to translate. This friend listens to your request, translates it, and communicates it to the waiter. While translating, your friend might adapt the message, for example, by mentioning that youâre foreign and prefer less spicy food..
đ Why use a connector?
Compatibility: The connector (your friend) bridges language barriers between you and the waiter, ensuring your order is understood. However, if you visit Germany, youâll need another friend who speaks German (i.e., a different connector).
Adaptation: Connectors can integrate business rules or controls to ensure messages are correctly processed.
âImportant note: Connectors exist physically somewhere. In our example, your friend is present with you. Alternatively, the connector could be a kitchen assistant who translates the waiterâs message for the chef. In this case, the connector is âhostedâ in the kitchen.
Keywords: API, automation, workflows, connectors
Related topics:
Do you still have questions? If you have any questions or need assistance, our support team is at your disposal via chat/messenger.