Guide de démarrage rapide pour votre intégration
Nous souhaitons que votre intégration soit mise en service rapidement afin que nous puissions, vous et nous, ouvrir de nouveaux marchés pour nos clients communs.
Page Intégrations d'Udemy Business, illustrée ci-dessous
Étapes préalables
- Demande de partenariat soumise et approuvée
- Provisionnement par Udemy de l'environnement de Sandbox pour Udemy Business
- L'administrateur Udemy invite des utilisateurs supplémentaires
Si vous ne disposez pas de tous ces éléments, reportez-vous au (Guide de démarrage) pour les obtenir
Cas d'utilisation d'intégrations de partenaires : vous pouvez consulter les cas d'utilisation généraux pris en charge par ces étapes d'intégration. Sinon, passez aux étapes de développement.
Étapes de développement
Pour limiter les risques techniques, nous vous recommandons de procéder en premier lieu à la connexion de toutes les API Udemy et de ne commencer à développer les logiciels qu'après avoir vérifié le bon fonctionnement de tous les points de terminaison.
- Connexion à l'API des cours, renvoie au moins 10 cours
- Connexion à l'API de cours, renvoie au moins 1 cours
- Connectez-vous à votre site Udemy Business et inscrivez-vous à un cours, puis visionnez une session pendant au moins 1 minute (vous pouvez accélérer la lecture)
- Connexion à l'API de génération de rapports (user-activity)
- Connexion à l'API de génération de rapports (user-course-activity)
- Connexion à l'API de génération de rapports (learning-activity-attempt)
- Connectez-vous à votre site Udemy Business et créez un parcours d'apprentissage (voir la documentation), ouvrez un cours et ajoutez-le au parcours d'apprentissage que vous venez de créer
- Connexion à l'API du parcours d'apprentissage, renvoie le parcours d'apprentissage créé
Configurations
Une fois que la plupart des API fonctionnent, vous pouvez passer aux étapes de configuration.
- La configuration de l'authentification unique (SSO) s'effectue directement au niveau de votre page Paramètres Udemy Business. Pour accéder à ces paramètres, vous devez disposer d'identifiants administrateur. Configurez une authentification unique prête à l'emploi par le biais de l'un de nos nombreux fournisseurs. Ou créez une connexion personnalisée via SAML 2.0. (lien vers la documentation relative à l'authentification unique)
- Parcourez le reste des paramètres sous [Udemy Business: Gérer: Paramètres] et personnalisez-les comme vous le souhaitez
Améliorations
Parcours d'apprentissage : ils permettent aux utilisateurs de créer un programme contenant une large variété de ressources d'apprentissage, dans un ordre précis pour guider le participant.
- Connectez-vous à votre site Udemy Business et créez un parcours d'apprentissage (voir la documentation), ouvrez un cours et ajoutez-le au parcours d'apprentissage que vous venez de créer
- Connexion à l'API du parcours d'apprentissage ; renvoie le parcours d'apprentissage créé
- Connexion à l'API de génération de rapports (learning-path-activity)
Génération de rapports en temps réel via un webhook
- Configuration de xAPI, le webhook d'Udemy permettant de générer des rapports sur les événements de progression et d'achèvement propres à un participant (voir la documentation). Vous ajoutez les paramètres sur la page des paramètres d'administration Udemy.
- Une fois la configuration effectuée, visionnez une courte session à la vitesse de lecture maximale et vérifiez si vous recevez vos données de progression.
Recherche de données sur un cours ou requêtes relatives : à l'aide de l'API GraphQL d'Udemy, nous intégrons les requêtes à notre catalogue de cours, en vous renvoyant uniquement les données dont vous avez besoin pour un cas spécifique d'utilisation. Nous fournissons également une API de recherche qui traite votre saisie en filtrant et renvoyant les résultats de cours pertinents.
- Obtention des identifiants de connexion API GraphQL
- Appel de la fonction GraphQL GetAuthToken()
- Utilisation de [authToken] pour appeler l'API des cours
- Appel de l'API CourseSearch
Remarque : une connexion Udemy Business est obligatoire pour accéder à la documentation GraphQL. L'URL applicable contient le sous-domaine du compte Udemy de votre organisation, suivi de .udemy.com/dev-portal/api-reference/.
Par exemple :
https://{votre_sous-domaine}.udemy.com/dev-portal/api-reference/.
Développement de logiciels de base
Une fois que tous les identifiants Udemy fonctionnent, que toutes les API sont connectées et que les configurations supplémentaires ont été effectuées, il n'y a plus de risques techniques. La plupart des partenaires vont alors passer à la planification ou au développement proprement dit. Il peut être judicieux de partir d'une liste de récits utilisateurs ou de cas d'utilisation pris en charge, et de mettre en corrélation les API Udemy requises pour chacun d'eux. À partir de là, place à l'ingénierie des logiciels !
Traitement des erreurs, exceptions et bonnes pratiques
Consolidez vos logiciels en incluant le traitement des erreurs, les exceptions et les cas en périphérie. Pour gérer les problèmes IT inattendus, nous vous proposons diverses recommandations en matière de traitement des erreurs.
Bonnes pratiques concernant les API Udemy Business
- Consignation des réponses aux erreurs renvoyées par les API
- Ajout d'une logique de nouvelle tentative pour les appels d'API
- Gestion des limites d'appels à l'aide des bonnes pratiques de taille de page
- Mise en œuvre des autres bonnes pratiques du document
Si vous avez besoin d'une assistance supplémentaire, si vous souhaitez nous faire part de vos commentaires ou si vous arrivez au terme de votre nouvelle intégration, contactez-nous à l'adresse partnersupport@udemy.com. Nous avons hâte d'ouvrir avec vous de nouveaux marchés grâce à notre fonctionnalité commune.