API OpenAPI

Dernière mise à jour : 15 mai 2025
  • S'applique à :
  • Experience Manager as a Cloud Service

Créé pour :

  • Administration
  • Développeur

Les nouvelles API d’AEM as a Cloud Service suivent la spécification OpenAPI et offrent donc un ensemble cohérent et bien documenté d’API.

REMARQUE
Un tutoriel complet est une ressource recommandée pour apprendre à configurer et à appeler les API AEM basées sur OpenAPI.

Pour les points d’entrée qui nécessitent une authentification, l’approche d’authentification diffère en fonction du point d’entrée, mais peut utiliser OAuth de serveur à serveur, l’application web OAuth ou l’application d’une seule page (SPA) OAuth. Les informations d'identification sont configurées via les projets dans Adobe Developer Console.

Les cas d’utilisation courants des API impliquent des intégrations à des systèmes tels qu’un CRM ou un PIM, où les API d’AEM sont appelées pour récupérer les données ou les conserver. Dans le cadre de la mise en œuvre de l’intégration, les applications peuvent s’abonner à des événements émis par AEM, ce qui peut déclencher une logique commerciale dans Adobe App Builder ou une autre infrastructure.

Ce document sert de présentation, mais une documentation plus approfondie est disponible dans les pages suivantes :

  • Les liens de la section API basée sur OpenAPI de la documentation de référence. La documentation de référence de chaque API comprend également un playground d’API, qui permet de tester facilement un point d’entrée à l’aide d’un jeton porteur généré avec le Adobe Developer Console.

  • Informations Guides, y compris concepts et syntaxe d’API.

  • Tutoriel de niveau supérieur décrivant les approches d’authentification et d’autres concepts.

  • Tutoriel vidéo sur comment configurer les API basées sur OpenAPI.

  • Tutoriel complet sur la configuration et l’appel des OpenAPI avec la stratégie d’authentification serveur à serveur. Vous trouverez des tutoriels similaires pour les approches Authentification par application web et Application d’une seule page .

Configuration de l’accès à l’API

Certaines API d'AEM basées sur OpenAPI nécessitent une authentification, qui nécessite que les informations d'identification soient générées à l'aide de Adobe Developer Console. La configuration comprend les étapes suivantes :

  1. Modernisation de l’environnement AEM as a Cloud Service.
  2. Activez l’accès aux API AEM à l’aide des profils de produit. Les profils de produit sont associés aux services qui représentent les groupes d’utilisateurs AEM avec des listes de contrôle d’accès (ACL) prédéfinies. Bien que certains services soient associés par défaut à des profils de produit spécifiques, d’autres doivent être associés explicitement ; par exemple, le service Utilisateurs de l’API AEM Assets n’est associé à aucun profil de produit, vous devez donc l’activer pour utiliser l’API AEM Assets. Pour plus d’informations, voir Étape du tutoriel Activer l’accès aux API AEM.
  3. Pour ajouter l’authentification de serveur à serveur, l’utilisateur configurant l’intégration doit être l’administrateur système de l’entreprise dans Adobe Admin Console ou ajouté en tant que développeur au profil de produit auquel le service est associé. Pour plus d’informations, voir Étape du tutoriel Activer l’accès aux API AEM.
  4. Créez un projet Adobe Developer Console (ADC).
  5. Configurez le projet ADC. Cela génère des informations d’identification qui seront utilisées ultérieurement pour échanger contre un jeton du porteur lors de l’appel de l’API.
  6. Configurez l’instance AEM pour activer la communication de projet ADC. Cela implique l’enregistrement de l’ID client avec l’environnement en configurant et en déployant un fichier YAML, comme décrit dans la section Enregistrement d’un ID client ci-dessous.

Pour obtenir des instructions détaillées, reportez-vous au tutoriel Configurer des API basées sur OpenAPI.