API OpenAPI openapi-based-apis
Les nouvelles API AEM as a Cloud Service suivent la spécification OpenAPI et génèrent ainsi des API cohérentes, bien documentées et conviviales. Des informations détaillées sont disponibles dans les pages suivantes :
- Un tutoriel complet sur la configuration et l’appel des API d’AEM OpenAPI.
- Guides d'informations, y compris concepts et syntaxe d'API.
- La documentation de référence du point d’entrée API, où certaines des API sont basées sur OpenAPI, comme cette API Sites. La documentation de référence comprend également un terrain de lecture API qui facilite l’essai d’un point de terminaison à l’aide d’un jeton porteur généré avec Adobe Developer Console.
Un cas d’utilisation d’API courant implique des intégrations avec des systèmes tels qu’un CRM ou un PIM, où AEM API sont invoquées pour récupérer ou conserver des données. Dans le cadre de la mise en oeuvre de l’intégration, les applications peuvent s’abonner à événements AEM émis, ce qui peut déclencher une logique métier dans Adobe App Builder ou dans d’autres infrastructures.
Les types d’authentification d’API pris en charge diffèrent selon le point de terminaison, mais il peut s’agir d’une application OAuth serveur à serveur, d’une application web OAuth et d’une application monopage OAuth (SPA).
Configuration de l’accès aux API configuring-api-access
De nombreuses 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, illustrées dans le tutoriel :
- Assurez-vous que les profils de produit de votre programme AEM sont mis à jouret qu’un service approprié est activé pour accéder à l’API souhaitée.
- Créez un projet dans Adobe Developer Console et ajoutez les API souhaitées au projet, en sélectionnant également le type d’authentification approprié.
- Générez les informations d’identification, qui seront ensuite utilisées pour exchange un jeton porteur lors de l’appel de l’API.
- Enregistrez l’ID client avec l’environnement en configurant un fichier YAML, qui est déployé à l’aide du pipeline de configuration (ou ligne de commande pour les RDE).
Enregistrement d’un ID de client registering-a-client-id
Les identifiants client étendent les API d’un projet Adobe Developer Console à des environnements AEM spécifiques. Pour ce faire, procédez comme suit :
-
Créez un fichier nommé
api.yamlou similaire avec une configuration comme le fragment de code ci-dessous, y compris les niveaux souhaités (auteur, publication, aperçu). Les valeursClient_iddoivent provenir de vos projets d’API Adobe Developer Console.Les propriétés
kind,versionetmetadatasont décrites dans l’article Config Pipeline . La valeur de la propriétékinddoit être définie sur API et la propriétéversiondoit être définie sur 1.code language-none kind: "API" version: "1" metadata: envTypes: ["dev"] data: allowedClientIDs: author: - "<client_id>" publish: - "<client_id>" preview: - "<client_id>" -
Placez le fichier quelque part sous un dossier de niveau supérieur nommé
configou similaire, comme décrit sous Config Pipeline. -
Pour les types d’environnements autres que RDE (qui utilise des outils de ligne de commande), créez un pipeline de configuration de déploiement ciblé dans Cloud Manager, comme référencé par cette section dans l’article Config Pipeline . Notez que les pipelines de pile complète et les pipelines de niveau web ne déploient pas le fichier de configuration.
-
Déployez la configuration.