Manuel du développeur d’applications

Adobe Captivate Prime est une solution de gestion d’apprentissage en libre service dédiée aux élèves et hébergée sur le cloud. L’API Prime permet d’accéder aux ressources disponibles sur Prime pour fournir un accès programmatique afin que les clients puissent étendre Prime et l’intégrer à d’autres applications d’entreprise qu’ils utilisent pour mettre en œuvre des flux de production transparents. L’API peut également être utilisée par les partenaires Adobe pour renforcer la proposition de valeur de Prime en étendant ses fonctionnalités ou par le biais d’intégrations avec des applications ou des services les plus répandus.

L’API Prime est basée sur les principes architecturaux de RST et expose les éléments clés du modèle d’objet Prime tels que l’utilisateur, le cours, le plan d’apprentissage et l’inscription en tant que ressources. Toutes les demandes d’API sont effectuées dans le contexte d’un utilisateur spécifique ayant été authentifié pour accéder à un compte Prime spécifique. Par conséquent, l’utilisateur sera capable d’accéder uniquement aux données de ce compte, qui est également régi par les rôles et les autorisations de l’utilisateur.

Dans la version 1, l’API Prime est principalement centrée sur la fourniture de l’accès GET à la plupart des ressources. Reportez-vous à la documentation de l’API pour obtenir une liste complète des points de terminaison et des méthodes. Prime dispose d’un modèle de données très riche avec plusieurs types d’objets (ressources) et des relations croisées. Par conséquent, nous avons décidé de suivre la spécification JSONAPI v1.0 qui permet au chargement latéral et aux réponses d’API d’être polymorphes.

À l’aide de l’API Prime, les développeurs peuvent créer des applications autonomes qui étendent la fonctionnalité de Prime, voire même intègrent Prime dans le contexte des flux de production spécifiques impliquant d’autres applications d’entreprise. L’application que vous développez est généralement déployée en dehors de la plate-forme Prime (il peut s’agir d’une application Web, de bureau ou mobile) et le développeur dispose d’un contrôle total sur la gestion de cette application tout au long de son cycle de vie. Les applications sont généralement développées par une organisation de client pour être utilisées avec leur compte Prime, et ces applications sont « privées » pour cette organisation spécifique de client. Cependant, les partenaires Adobe peuvent également utiliser l’API Prime pour créer des applications génériques qui pourraient être d’intérêt « commun » à un grand ensemble de clients Prime.

La section suivante propose une présentation rapide de grande qualité de l’API Prime et présente le code d’un exemple d’application. La suite de ce document se concentre sur les mécanismes de la façon dont les développeurs peuvent obtenir et gérer les clés pour leurs applications et sur la fiabilité des applications pour une utilisation par des comptes Prime. Pour plus d’informations sur les différents points de terminaison et méthodes d’API, reportez-vous à la documentation de l’API.

API Prime

L’API Prime est basée sur des principes REST et expose les éléments clés du modèle d’objet Prime aux développeurs d’applications via HTTP. Avant d’entrer dans les détails des points de terminaison de l’API et des méthodes HTTP, les développeurs peuvent trouver utile de se familiariser dans un premier temps avec les différents objets Prime, leurs attributs et leurs relations croisées. Une fois les modèles bien compris, il est utile de bien cerner la structure des demandes et des réponses d’API et de bien comprendre quelques expressions courantes de programmation que nous prenons en charge de manière générique dans l’ensemble de l’API.  Enfin, cette section se termine par une présentation du code d’un exemple simple.

Modèles Prime

L’API Prime permet aux développeurs d’accéder aux objets Prime en tant que ressources RESTful. Cela signifie intrinsèquement que chaque point de terminaison de l’API représente une ressource (il s’agit généralement d’une instance d’objet comme un badge ou un ensemble de tels objets). Les développeurs utilisent ensuite les verbes HTTP tels que PUT, GET, POST et DELETE pour effectuer des opérations CRUD sur ces objets (collections).

Le tableau suivant répertorie les différents éléments du modèle d’objet Prime

Processus de développement de l’application

Développement et test

Obtenir le compte de développement

Il est recommandé au développeur de créer tout d’abord un compte d’évaluation sur Prime, afin de pouvoir bénéficier d’un accès complet à tous les rôles dans ce compte. Pour pouvoir créer une application, le développeur doit également créer certains utilisateurs et cours et obtenir un état satisfaisant pour le compte, de façon à ce que l’application en cours de développement puisse avoir accès à des données factices.

Créer l’ID et le secret client

Expliquez la manière dont vous pouvez opter pour un rôle d’administrateur d’intégration et enregistrer une nouvelle application. Afficher la capture d’écran et expliquer les différents champs

Effectuer le développement et le test d’applications

L’API Prime peut être utilisée par les développeurs pour créer toutes sortes d’applications. Pendant le développement, le développeur devra s’assurer que le compte d’évaluation dispose d’utilisateurs et de cours. Il est conseillé au développeur de créer au moins quelques utilisateurs et cours factices et de simuler l’activité du compte d’évaluation, de façon à pouvoir tester le fonctionnement de l’application.