Modifications apportées aux API dans la version de septembre 2026 de Adobe Learning Manager
API de vérification de l’accès au catalogue pour les objets d’apprentissage
Déterminez si l’élève actuel a un accès direct au catalogue à un ou plusieurs objets d’apprentissage, indépendamment du fait qu’il ait atteint ce contenu via un parcours d’apprentissage ou une certification.
Objectif de l’API
Lorsqu’un élève ouvre un parcours d’apprentissage ou une certification, il peut parcourir les cours individuels qu’il contient, même si un cours spécifique ne lui est pas directement attribué par le biais d’un catalogue. Cela prend en charge la découverte de contenu : les élèves peuvent explorer ce que contient un parcours d’apprentissage avant de décider de le poursuivre ou non.
Cependant, le fait de pouvoir afficher un cours de cette manière ne devrait pas signifier automatiquement que l’élève peut s’y inscrire. L’inscription doit dépendre de l’accès direct ou non de l’élève au catalogue de ce cours spécifique, et pas seulement un accès indirect via un parcours d’apprentissage conteneur.
Cette API vous permet de vérifier, pour un élève donné, si un ou plusieurs objets d’apprentissage sont directement accessibles via un catalogue qui leur est attribué. Utilisez le résultat pour contrôler l’interface utilisateur liée à l’inscription, par exemple, en affichant une option d’inscription uniquement lorsque l’accès direct au catalogue est confirmé, tout en conservant la page du cours elle-même visible dans les deux cas.
Point de terminaison
GET /primeapi/v2/learningObjects/isMemberOfVisibleCatalogs
Paramètres de requête
Exemple de requête
GET /primeapi/v2/learningObjects/isMemberOfVisibleCatalogs?ids=course%3A2400159%2Ccourse%3A2400160%2Ccourse%3A2400161%2Ccourse%3A2400162
Accept: application/vnd.api+json
Authorization: oauth <access-token>
Exemple de réponse - 200 OK
{
"course:2400162": false,
"course:2400161": false,
"course:2400160": true,
"course:2400159": true
}
Codes de réponse
Exemple de réponse d’erreur
{
"status": "BAD_REQUEST",
"title": "Bad request. Check url, params and headers",
"source": {
"info": "Either LO id is blank or not as per public api specification"
}
}
Utiliser cette API dans votre intégration
Un cas d’utilisation courant est une page de cours accessible par un élève en naviguant à partir d’un parcours d’apprentissage. Vous souhaitez que la page du cours elle-même reste accessible pour la découverte, tout en affichant l’action S’inscrire uniquement si l’élève a un accès direct au catalogue de ce cours.
- Lorsque la page du cours se charge, appelez ce point de terminaison avec l’ID de l’objet d’apprentissage du cours.
- Si la réponse renvoie la valeur true pour cet ID, affichez l’option S’inscrire.
- Si la réponse renvoie la valeur false, conservez la page du cours visible, le titre, la description et les détails du cours, mais masquez l’option S’inscrire.
API de tâche pour le rapport de piste d’audit d’administrateur apiaudittrailreport
Objectif de l’API
Le rapport de piste d’audit de l’administrateur répertorie les modifications de configuration apportées à un
Compte Adobe Learning Manager. Par exemple, les modifications apportées aux notions de base, aux intégrations ou
Paramètres de compte avancés sur une période donnée. La génération du rapport de journal d’audit nécessite l’interrogation et l’agrégation des enregistrements de modification de configuration dans la plage de dates et les types de paramètres demandés. Selon la taille de la plage et le volume des modifications, cela peut dépasser les limites de temps d’une requête HTTP synchrone, ce qui risque de provoquer des dépassements de délai du client ou de la passerelle.
Pour éviter cela, le rapport est généré de manière asynchrone via l’API de tâche générique :
-
Créer un emploi. L’administrateur soumet une demande en spécifiant le type de rapport, la plage de dates et les types de paramètres. L’API renvoie immédiatement un ID de tâche, sans attendre la compilation du rapport.
-
Interrogation du travail. L’administrateur récupère régulièrement le travail à l’aide de son ID pour vérifier son statut. Une fois la tâche terminée, la réponse contient le résultat ou une référence à celui-ci.
URL de base et conventions
/primeapi/v2application/vnd.api+json;charset=UTF-8 (JSON:API)x-acap-account identifiant le compte de l’administrateur appelantstatus ne soit plus QUEUED ou IN_PROGRESSID
La tâche id renvoyée lors de la création d’une tâche est une chaîne opaque (par exemple,4593). Toujours transmettre la valeur id exacte que vous avez reçue de la création
réponse lors de l’interrogation du statut. Ne le construisez jamais ni ne l’analysez.
Portées d’authentification
Chaque point de terminaison nécessite un jeton OAuth portant l’étendue suivante, et la
l’utilisateur appelant doit détenir le rôle d’administrateur de compte :
admin:writecréer une tâche de rapport (ROLE_ADMINrequis)admin:reada lu l’état et le résultat d’une tâche (ROLE_ADMINrequis)
Les demandes effectuées par un appelant qui ne détient pas ROLE_ADMIN sur le compte sont les suivantes :
rejeté ; voir Gestion des erreurs
Points de terminaison
Création d’une tâche de rapport de piste d’audit
POST /primeapi/v2/jobs
Crée une tâche asynchrone qui génère un rapport de journal d’audit de modification de configuration
pour la plage de dates et les types de paramètres donnés. La réponse revient immédiatement
avec une ressource de tâche dans l’état QUEUED ; le rapport lui-même est produit dans le
arrière-plan.
Portée : admin:write
jobTypegenerateConfigChangeAuditReport pour ce rapportpayload.fromDate2026-09-15T00:00:00.000+05:30payload.toDate2026-09-23T23:59:59.000+05:30payload.settingTypesBasics, Integrations et AdvancedExemple de corps de requête
{
"data": {
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"payload": {
"fromDate": "2026-09-15T00:00:00.000+05:30",
"toDate": "2026-09-23T23:59:59.000+05:30",
"settingTypes": ["Basics", "Integrations", "Advanced"]
}
}
}
}
Réponse : 202 Created. Le corps de la réponse est la ressource de travail dans sa version initiale
État QUEUED.
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "QUEUED",
"dateCreated": "2026-09-23T18:12:04.000+05:30"
}
}
}
fromDate/toDate qui s'étend sur une très grande plage de dates, ou quedemande tous les types de paramètres pour un compte avec un long historique des modifications, peut
le traitement prend plus de temps. Interrogation du point de terminaison Obtenir le statut de la tâche plutôt que
en supposant que le rapport est prêt après un délai déterminé.
Obtenir le statut d’une tâche de rapport de piste d’audit
GET /primeapi/v2/jobs/{id}
Renvoie l’état actuel d’une tâche créée précédemment. Tant que le travail est
en cours d’exécution, attributes.status est QUEUED ou IN_PROGRESS etattributes.result est absent. Une fois le travail terminé, attributes.status est
soit COMPLETED, avec l’emplacement du rapport dans attributes.result,FAILED, avec détails d’échec dans attributes.error.
Portée : admin:read
idExemple de réponse pendant l’exécution de la tâche
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "IN_PROGRESS",
"dateCreated": "2026-09-23T18:12:04.000+05:30"
}
}
}
Exemple de réponse une fois la tâche terminée
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "COMPLETED",
"dateCreated": "2026-09-23T18:12:04.000+05:30",
"dateCompleted": "2026-09-23T18:12:41.000+05:30",
"result": {
"downloadUrl": "https://learningmanager.adobe.com/primeapi/v2/jobs/4593/download",
"expiresAt": "2026-09-24T18:12:41.000+05:30"
}
}
}
}
Schéma de la ressource
Attributs de la tâche
idjobTypegenerateConfigChangeAuditReport pour ce rapportstatusQUEUED, IN_PROGRESS, COMPLETED ou FAILEDdateCreateddateCompletedstatus est COMPLETED ou FAILEDpayloadresultstatus est COMPLETED (intégré - voir ci-dessous)errorstatus est FAILEDCharge utile (intégrée, dans la demande de création)
fromDatetoDatesettingTypesBasics, Integrations, AdvancedRésultat (incorporé, dans une tâche terminée)
downloadUrlexpiresAtdownloadUrl cesse d’être valide, demandez une nouvelle vérification de l’état pour obtenir un nouveau lien après cette heureGestion des erreurs audit-trail-report-error-handling
Les codes suivants s’appliquent à ces points de terminaison :
BAD_REQUESTtoDate est antérieur à fromDate, settingTypes est vide ou contient une valeur non prise en charge, ou une date n’est pas valide selon la norme ISO-8601 - Créer un point de terminaison uniquementUNAUTHORIZED_ACCESSFORBIDDENROLE_ADMIN sur le compteOBJECT_DOESNT_EXISTExemple de réponse d’erreur
{
"status": "BAD_REQUEST",
"title": "Bad request. Check url, params and headers",
"source": {
"info": "toDate must be on or after fromDate"
}
}
Utiliser cette API dans votre intégration
Un cas d’utilisation courant est une action « Télécharger la piste d’audit » destinée aux administrateurs dans le
écran paramètres du compte.
- Lorsque l’administrateur sélectionne une plage de dates et un ou plusieurs types de paramètres et
confirme, appelez le point de terminaison create-job avec ces valeurs. - Stockez la tâche renvoyée
idet interrogez le point de terminaison Obtenir le statut de la tâche à un
intervalle raisonnable (par exemple, toutes les quelques secondes). - Tant que
statusestQUEUEDouIN_PROGRESS, continuez à afficher un état de progression
dans l’interface utilisateur. - Lorsque
statusdevientCOMPLETED, utilisezresult.downloadUrlpour laisser le
l’administrateur télécharge le rapport avant le passage deexpiresAt. - Lorsque
statusdevientFAILED, faites défilererrorvers l’administrateur et laissez-le
réessayez.