Documentation et guides d'assistance

Les API d'Udemy Business permettent l'intégration via plusieurs méthodes différentes pour vous offrir plus de flexibilité dans le développement de vos logiciels.  Cet article présente quelques-unes des utilisations possibles pour chaque API ainsi que des recommandations pour choisir celles qui vous conviennent.

• Consultez les cas d'utilisation d'intégrations de partenaires pris en charge par Udemy

Table des matières

• Cours et tous les objets d'apprentissage
• Génération de rapports
• Parcours d'apprentissage
• Authentification unique (SSO)
• Ancienne API de cours
• Intégrations recommandées

Cours et tous les objets d'apprentissage

API de cours GraphQL - Protocole : GraphQL 

• La nouvelle génération et la version avancée de l'API de cours traditionnelle. GraphQL vous permet, pour chaque cours, de récupérer uniquement les métadonnées de cours spécifiées. De plus, le système de requêtes de GraphQL vous renvoie les cours qui correspondent à vos critères. 

Remarque : pour en savoir plus sur la technologie derrière GraphQL, consultez la page de l'organisation GraphQL.

API de tous les objets d'apprentissage GraphQL  - Protocole : GraphQL 

• Au-delà des cours, Udemy propose de nombreuses façons d'apprendre.  Nous fournissons tous les objets d'apprentissage par le biais d'une API pour les intégrer à votre système.  Cette API vous permet d'obtenir les cours, les exercices d'application et les badges.  Comme pour les autres services GraphQL, vous pouvez utiliser les requêtes pour récupérer uniquement les objets et les champs spécifiés.

Documentation :  pour accéder à la documentation GraphQL, vous devez avoir accès à Udemy Business. Consultez le portail des développeurs à l'URL suivante : https://{votre_sous-domaine}.udemy.com/dev-portal/api-reference/

Génération de rapports

API de génération de rapports - Protocole : RESTful 

• Cette API contient toutes les données utilisateur collectées sur la progression, la complétion et les actions effectuées dans le cadre de l'apprentissage.  Vous pouvez choisir de récupérer les données de rapport de tous les utilisateurs ou spécifier un groupe d'utilisateurs. En raison de la quantité de données, les actions des utilisateurs sont collectées et rapportées en différé.

Documentation : Documentation API Udemy Business - API RESTful

xAPI - Protocole : xAPI

• Génération de rapports en temps réel, transmis via un webhook, conçue selon les normes xAPI EdTech.  Udemy vous envoie en temps réel les données de progression et de rapport.  Les données contenues dans ces événements en temps réel ont une portée moindre par rapport à l'API de génération de rapports RESTful.

Documentation : Documentation xAPI Udemy Business

Parcours d'apprentissage

API de parcours d'apprentissage - Protocole : RESTful 

• Udemy permet aux participants et aux administrateurs A&D de créer des parcours d'apprentissage, une collection de plusieurs cours et tout autre type d'objet d'apprentissage, y compris des liens externes. Nous fournissons ces parcours d'apprentissage via une API et renvoyons tous les parcours et les éléments qu'ils contiennent.

Documentation : Documentation API Udemy Business - API RESTful

Authentification unique (SSO)

Udemy Business peut se connecter à tous les services d'authentification unique SAML 2.0, qui incluent la plupart des fournisseurs de SSO. Des intégrations SSO personnalisées sont également disponibles, à condition qu'elles suivent la norme SAML 2.0.

Protocole : SAML 2.0 ou version ultérieure

Documentation : Présentation de l'authentification unique Udemy Business et de ses fonctionnalités principales

API de provisionnement des utilisateurs SCIM - Le provisionnement SCIM (System for Cross-domain Identity Management) vous permet de provisionner et de déprovisionner des licences utilisateur. Ce système permet à vos équipes informatiques ou à vos intégrations personnalisées d'automatiser la gestion des licences.

Protocole : SCIM

Documentation : ​​Provisionnement SCIM (System for Cross-domain Identity Management)

Ancienne API de cours 

API de cours  - Protocole : RESTful 

• L'API de cours suit les normes traditionnelles EdTech. Elle récupère toutes les métadonnées d'un seul cours ou de l'ensemble des cours.

Remarque : il s'agit de notre ancienne API de cours, pour laquelle nous ne publierons plus de nouvelles fonctionnalités.  Toutes les nouvelles fonctionnalités sortiront sur nos API GraphQL, qui ne contiennent pas seulement les cours, mais aussi tous les objets d'apprentissage.

Documentation : Documentation API Udemy Business - API RESTful

Intégrations recommandées

Nous savons que chaque client et partenaire d'Udemy est différent et a des besoins uniques. Pour bénéficier de la meilleure intégration, nous vous recommandons d'utiliser les API suivantes :

1. Cours et objets d'apprentissage : utilisez l'API GraphQL pour accéder à tous les objets d'apprentissage

2. Génération de rapports : utilisez l'API REST pour l'ensemble des données et complétez-la avec xAPI pour obtenir des données en temps réel

3. SSO : doit être utilisé avec le SCIM pour automatiser le provisionnement et le déprovisionnement des utilisateurs

4. Parcours d'apprentissage : utilisez l'API de parcours d'apprentissage pour permettre aux administrateurs A&D et aux responsables des programmes de créer des parcours d'apprentissage pour l'utilisateur final

Udemy Business - Améliorer des vies grâce à l'apprentissage

Accédez au moteur d'apprentissage d'Udemy et proposez du contenu de développement professionnel au sein de vos réseaux et écosystèmes grâce à un vaste éventail de solutions de connectivité et d'applications dans leurs versions les plus abouties. Ces dernières vous permettront de faire participer des personnes à vos plates-formes et services en ligne, ainsi qu'aux services d'apprentissage Udemy. 

Udemy Business propose des milliers de cours créés et mis à jour au gré de l'évolution du marché (par exemple, le moteur d'apprentissage).  Du codage aux compétences métier en passant par le développement personnel et bien plus encore, Udemy propose des cours en ligne de qualité et à la demande qui aident les personnes à atteindre leurs objectifs professionnels et à générer des résultats métier.

Grâce à une intégration spécifique à Udemy Business, vos services vont permettre aux utilisateurs de rechercher et de découvrir les cours (et les parcours d'apprentissage) Udemy Business les mieux notés directement depuis votre plate-forme, avec la possibilité d'accéder à un site Udemy Business dédié pour une expérience de cours complète. 

Table des matières :

Cas d'utilisation n° 1 : Intégration de contenu

Principaux avantages 

Cas d'utilisation n° 2 : Progression de l'utilisateur et analyses

Principaux avantages 

Calendrier et étapes de l'intégration

Architecture de référence de haut niveau

Une intégration Udemy Business couvre les deux principaux cas d'utilisation suivants : 

Cas d'utilisation n° 1 : Intégration de contenu

Les intégrations de contenu étendent l'accès à l'apprentissage en ligne d'Udemy Business (par ex., les cours et les parcours d'apprentissage) et renforcent vos offres de services en ligne de base.  Grâce à l'intégration de contenu d'Udemy Business, les partenaires peuvent proposer des fonctionnalités de recherche et de découverte des cours en ligne et des parcours d'apprentissage (objectifs d'apprentissage structurés) Udemy Business directement sur les applications Web et/ou mobiles natives des partenaires.  Vos utilisateurs pourront découvrir le contenu (ou les parcours d'apprentissage) Udemy  et s'y immerger dans une expérience native familière.  Le contenu Udemy Business intégré offre aux utilisateurs (et aux partenaires) une interface d'interaction transparente avec le site et les services des partenaires.  L'intégration de contenu se fait par le biais de services Web modernes (par ex., des API) qui se connectent à un puissant moteur d'apprentissage en ligne.  Udemy aide ses partenaires à définir la portée et la conception du connecteur d'intégration de contenu, en leur proposant notamment des conseils en matière de conception, de tests, de déploiement et de gestion du cycle de vie du connecteur, afin de renforcer l'expérience autour des applications Web (ou mobiles) natives des partenaires. 

Principaux avantages :

• Accès aux tout derniers contenus d'apprentissage en ligne pour le développement professionnel et personnel directement depuis les applications Web et mobiles natives
• Hausse de l'implication sur le contenu actuel grâce à une synchronisation automatique transparente
• Navigation aisée parmi les contenus grâce à une expérience de recherche et de découverte intuitive
• Suivi de la progression de l'apprentissage en temps quasi réel et aide au développement de l'employé
• Accès facile et sécurisé grâce aux services d'authentification unique (SSO)
• Incorporez l'apprentissage dans vos applications Web et mobiles natives pour une expérience d'apprentissage en déplacement

Cas d'utilisation n° 2 : Progression de l'utilisateur et analyses

Découvrez quels sont les besoins en matière d'apprentissage de vos utilisateurs en intégrant les données des participants Udemy Business. En incluant l'implication des utilisateurs, leur progression et l'achèvement des cours dans vos analyses, vous pouvez personnaliser et développer en permanence des expériences guidées qui tiennent compte des besoins individuels et des concepts clés (par ex., avec des parcours d'apprentissage spécifiques).  Les analyses d'apprentissage reposent sur un vaste ensemble de données relatives à l'implication des utilisateurs. Cela permet à nos partenaires d'élaborer des modèles d'apprentissage composites pour leurs utilisateurs à partir d'ensembles de données uniques afin d'améliorer en permanence l'expérience d'apprentissage des utilisateurs. 

Principaux avantages :

• Mise en place d'analyses composites d'apprentissage pour découvrir les principaux besoins de vos utilisateurs en matière d'apprentissage
• Utilisation des informations sur l'apprentissage pour adapter le contenu Udemy Business à votre public
• Développement de vos offres de services grâce à l'intelligence artificielle pour identifier les besoins et les intérêts spécifiques de vos utilisateurs.
• Évaluation et développement continus d'une expérience d'apprentissage complète qui favorise une expérience d'apprentissage holistique et des services groupés

Explorez l'écosystème des partenaires Udemy, développé grâce aux services Udemy Business et au puissant moteur d'apprentissage d'Udemy 

Calendrier et étapes de l'intégration

En moyenne, les partenaires consacrent 4 semaines à la conception, au développement et au déploiement d'un connecteur basé sur l'API pour les cas d'utilisation ci-dessus.  Udemy Business désigne un ingénieur des solutions et responsable partenaire qui va suivre l'ensemble du projet de développement du connecteur. L'objectif est de guider les partenaires et de leur conseiller les bonnes pratiques à adopter pour optimiser l'intégration avec les API Udemy. 

Architecture de référence de haut niveau

Les éléments de base de l'intégration sont décrits ci-dessous.  La synchronisation des données est assurée par les API Udemy Business et orchestrée par le connecteur développé par un partenaire.  La recherche et la découverte des cours et des parcours d'apprentissage Udemy s'effectuent via le connecteur directement sur les applications Web et mobiles natives des partenaires. 

Grâce à l'authentification unique optionnelle, les utilisateurs sont connectés de manière transparente à un site Udemy Business directement depuis la plate-forme d'apprentissage des partenaires.

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. 

• 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.

Les partenaires technologiques d'Udemy Business exploitent des API de plate-forme pour automatiser la synchronisation de la sélection de contenu UB et des données d'activité des participants au niveau de la plate-forme du partenaire. Les intégrations sont disponibles pour nos clients communs uniquement. Prêt à concevoir une intégration avec Udemy Business ? Vous trouverez ci-dessous de la documentation pour vous aider à vous lancer.

• Résumé des API disponibles
• Cas d'utilisation et bonnes pratiques concernant les API Web Udemy Business
• Cas d'utilisation d'intégrations de partenaires 
• Étapes d'intégration pour les partenaires technologiques

Avec les API Web Udemy Business (REST/GraphQL/xAPI), connectez facilement vos outils d'administration, votre plate-forme LMS et vos suites RH au catalogue de cours Udemy (via les métadonnées) et aux données d'implication des participants.

Favorisez l'apprentissage sur le lieu de travail grâce aux fonctionnalités suivantes :

• Synchronisation automatique des données utilisateurs entre Udemy Business et votre annuaire des employés (par exemple : Okta, Azure)
• Intégration de la recherche, de la détection et du lancement des cours et sessions de cours Udemy Business à vos systèmes RH
• Récupération en temps réel des analyses de participation aux cours pour votre organisation directement depuis vos applications

Remarque : le guide cité ici et dont le lien est fourni ci-dessous est publié sur le centre d'aide Udemy Business.

• En savoir plus : Cas d'utilisation et bonnes pratiques concernant les API Web Udemy Business