Motimate : Comment utiliser l'API publique de Motimate ?
Utilisez l'API publique pour automatiser l'intégration et la synchronisation des utilisateurs avec votre source de données, et connectez Motimate à d'autres services intéressants 🔀
L'API publique v2 est désormais disponible pour tous les clients !
- Documentation pour PAPI v1 (uniquement pour l'héritage - tous les nouveaux clients obtiendront la v2)
- Documentation pour PAPI v2
L'API publique est un ensemble de services qui peuvent être utilisés pour mettre à jour et gérer les données dans Motimate. Elle est documentée de manière standard, appelée OpenAPI, et fournit aux développeurs un accès programmatique à notre logiciel en tant que service. Cette API offre un support plus large que ce que vous pouvez faire avec SCIM et CSV, mais vous avez besoin d'un service d'intégration ou d'un robot logiciel pour l'utiliser.
Le lancement de PAPI v2 rend plus facile que jamais l'exportation de données depuis votre MotiSpace, avec des points de terminaison tels que :
- /motis/progresses
- /motis/chapter_completions
- /posts et
- /connaissances/apprentissages/report_requests
A noter :
- Vous devez demander vos identifiants API à l'assistance pour commencer à utiliser ce service.
- La base de données de l'API est rafraîchie à intervalles réguliers , plusieurs fois par heure.
Modèles de données
L'API publique fournit des modèles pour automatiser le provisionnement des utilisateurs et les postes Pulse. Il dispose de ces modèles de données :
-
Modèle d'utilisateur : Vous pouvez l'utiliser pour lire, écrire et mettre à jour des informations sur les comptes d'utilisateurs. Il peut s'agir d'informations de contact, de rôles d'accès et d'attributions de groupes pour la gestion du mobile. Si un utilisateur a une ou plusieurs positions, cela peut également être défini dans ce point de terminaison.
-
Modèle des groupes : Il permet de lire, d'écrire et d'attribuer des groupes d'utilisateurs. Ces groupes peuvent également être structurés en arborescence pour s'adapter à votre organisation et simplifier les missions d'apprentissage.
Important : le niveau de groupe est actuellement défini à l'aide de l'attribut kind. La valeur de la nature peut varier d'une organisation à l'autre. Il peut également être modifié facilement par l'administrateur de votre organisation. Lors de la configuration de l'intégration API, il est conseillé de définir une liste permanente de noms de type pour vos niveaux de groupe afin d'éviter toute erreur potentielle dans l'intégration API en cas de changement des noms de type.
-
Modèle des positions : Ce modèle permet de lire et d'écrire les positions auxquelles les comptes d'utilisateurs peuvent être affectés.
-
Posts : Vous pouvez utiliser cette fonction pour créer des messages et les publier sur Pulse. Cela peut être fait en combinaison avec les services de fichiers pour télécharger des images.
-
Fichiers : Ce service est utilisé pour télécharger des images pour les messages Pulse. La taille des images est limitée à 40 Mo, celle des vidéos à 100 Mo et celle des documents à 100 Mo.
- Aperçu : Ce service permet de générer et d'obtenir un lien vers un rapport personnalisé. Le modèle de rapport doit être créé au préalable dans la plateforme Motimate à l'aide de la fonction "Générer des rapports" sous "Insights".
Authentification
Le point de terminaison OAuth Token est utilisé pour créer un jeton d'accès. Obtenez votre numéro de client et votre secret de client en contactant support@motimateapp.com.
Une fois que vous avez reçu ces informations, les jetons peuvent être générés de manière programmatique ou via des plateformes telles que Postman. Tout ce que vous avez à faire est d'envoyer un appel API au point de terminaison POST /oauth/tokensavec les informations d'identification client_id et client_secret que vous avez reçues de l'assistance Motimate en tant que corps JSON.
L'API répondra avec un jeton unique, qui sera valide pendant 24 heures. Vous pouvez générer autant de jetons que nécessaire. Le jeton doit être transmis à l'en-tête Authorization en tant que jeton Bearer dans les demandes adressées à tous les autres points d'accès ("Bearer "+[your_token]).
Exemple :"Bearer eyJhbkyFjHk0oIY6ghkkgRI1NiJ9.eyJ0b23Lo7G5jk7mJkYzdiZD"
Vous pouvez utiliser le point de terminaison GET /me est utilisé pour vérifier le jeton d'accès. Ceci est utile si vous disposez d'un keystore pour conserver votre jeton d'accès et que vous souhaitez vérifier qu'il fonctionne sans invoquer d'appels transactionnels.
Comment tester l'API :
Pour tester l'API, nous vous recommandons d'utiliser une plateforme API telle que Postman. Vous pouvez trouver un guide sur la façon d'importer la documentation complète de l'API Motimate dans Postman et Insomnia Collections ici.
Vous devez créer votre jeton d'accès à l'API comme décrit ci-dessus, puis saisir ce jeton en tant que jeton porteur dans l'onglet Autorisation de Postman. Vous pouvez ensuite tester l'API et examiner les réponses.
0 commentaire
Vous devez vous connecter pour laisser un commentaire.