API AEM basées sur OpenAPI
Découvrez les API AEM basées sur OpenAPI, notamment la prise en charge de l’authentification, les concepts clés et comment accéder aux API Adobe.
La spécification OpenAPI (anciennement connue sous le nom de Swagger) est une norme largement utilisée pour définir les API RESTful. AEM as a Cloud Service fournit plusieurs API basées sur la spécification OpenAPI (ou simplement des API AEM basées sur OpenAPI), ce qui facilite la création d’applications personnalisées qui interagissent avec les types de services de création ou de publication d’AEM. Voici quelques exemples :
Sites
- API Sites : API permettant d’utiliser des fragments de contenu.
Assets
-
API de dossiers : API permettant d’utiliser des dossiers tels que les dossiers de création, de liste et de suppression.
-
API de création Assets : API permettant d’utiliser des ressources et leurs métadonnées.
Forms
- API Forms Communications : API permettant d’utiliser des formulaires et des documents.
Dans les prochaines versions, d’autres API AEM basées sur OpenAPI seront ajoutées pour prendre en charge d’autres cas d’utilisation.
Prise en charge de l’authentification authentication-support
Les API AEM basées sur OpenAPI prennent en charge l’authentification OAuth 2.0, y compris les types d’octroi suivants :
-
Informations d’identification de serveur à serveur OAuth : option idéale pour les services principaux nécessitant un accès à l’API sans interaction avec l’utilisateur ou l’utilisatrice. Elle utilise le type d’octroi client_credentials, permettant une gestion sécurisée des accès au niveau du serveur. Pour plus d’informations, consultez Informations d’identification de serveur à serveur OAuth.
-
Informations d’identification de l’application web OAuth : option adaptée aux applications web avec des composants front-end et back-end qui accèdent aux API AEM pour le compte des utilisateurs et utilisatrices. Elle utilise le type d’octroi authorization_code, où le serveur principal gère en toute sécurité les secrets et les jetons. Pour plus d’informations, consultez Informations d’identification de l’application web OAuth.
-
Informations d’identification d’application d’une seule page OAuth : option conçue pour les SPA s’exécutant dans le navigateur, qui doit accéder aux API au nom d’un utilisateur ou d’une utilisatrice sans serveur principal. Elle utilise le type d’octroi authorization_code et s’appuie sur des mécanismes de sécurité côté client utilisant PKCE (Proof Key for Code Exchange) pour sécuriser le flux de code d’autorisation. Pour plus d’informations, consultez Informations d’identification d’application d’une seule page OAuth.
Quelle méthode d’authentification utiliser auth-method-decision
Lorsque vous décidez de la méthode d’authentification à utiliser, tenez compte des points suivants :
L’authentification de l’utilisateur ou de l’utilisatrice (application web ou application d’une seule page) doit être le choix par défaut chaque fois que le contexte d’utilisation AEM est impliqué. Cela permet de s’assurer que toutes les actions du référentiel sont correctement attribuées à la personne authentifiée et que celle-ci est limitée aux seules autorisations auxquelles elle a droit.
L’utilisation de l’option serveur à serveur (ou d’un compte système technique) pour effectuer des actions au nom d’une personne individuelle contourne le modèle de sécurité et introduit des risques tels que la réaffectation des privilèges et un audit inexact.
Différence entre les informations d’identification de serveur à serveur, d’application web et d’application d’une seule page OAuth difference-between-oauth-server-to-server-vs-web-app-vs-single-page-app-credentials
Le tableau suivant résume les différences entre les trois méthodes d’authentification OAuth prises en charge par les API AEM basées sur OpenAPI :
client_id, client_secret) dans les systèmes principaux.client_id, client_secret) dans les systèmes principaux pour échanger le code d’autorisation contre le jeton d’accès.client_secret, car le stockage dans les applications frontales n’est pas sécurisé. Dépend de PKCE pour échanger le code d’autorisation contre le jeton d’accès.Accès aux API Adobe et concepts associés accessing-adobe-apis-and-related-concepts
Avant d’accéder aux API Adobe, il est essentiel de connaître les éléments clés suivants :
-
Adobe Developer Console : hub de développement permettant d’accéder aux API, aux SDK, aux événements en temps réel et aux fonctions sans serveur d’Adobe, etc. Notez qu’elle est différente de l’AEM Developer Console, qui est utilisée pour le débogage des applications AEM.
-
Projet Adobe Developer Console : emplacement central pour la gestion des intégrations d’API, des événements et des fonctions d’exécution. Ici, vous configurez les API, définissez l’authentification et générez les informations d’identification requises.
-
Profils de produit : les profils de produit fournissent un paramètre d’autorisation prédéfini qui vous permet de contrôler l’accès des utilisateurs et utilisatrices ou des applications aux produits Adobe tels qu’AEM, Adobe Target, Adobe Analytics, etc. Chaque produit Adobe est associé à des profils de produit prédéfinis.
-
Services : les services définissent les autorisations réelles et sont associés au profil de produit. Pour réduire ou augmenter le paramètre prédéfini des autorisations, vous pouvez désélectionner ou sélectionner les services associés au profil de produit. Vous pouvez ainsi contrôler le niveau d’accès au produit et à ses API. Dans AEM as a Cloud Service, les services représentent des groupes d’utilisateurs et d’utilisatrices disposant de listes de contrôle d’accès (ACL) prédéfinies pour les nœuds de référentiel, ce qui permet une gestion des autorisations granulaire.
Commencer
Découvrez comment configurer votre environnement AEM as a Cloud Service et un projet Adobe Developer Console pour activer l’accès aux API AEM basées sur OpenAPI. Accédez également à l’API AEM à l’aide du navigateur pour vérifier la configuration et examiner la demande et la réponse.
Configurer les API AEM basées sur OpenAPI
Découvrez comment configurer votre environnement AEM as a Cloud Service pour activer l’accès aux API AEM basées sur OpenAPI.
Tutoriels sur les API
Découvrez comment utiliser les API AEM basées sur OpenAPI à l’aide de différentes méthodes d’authentification OAuth :
Appeler l’API à l’aide de l’authentification de serveur à serveur
Découvrez comment appeler les API AEM basées sur OpenAPI à partir d’une application NodeJS personnalisée à l’aide de l’authentification de serveur à serveur OAuth.
Appeler l’API à l’aide de l’authentification d’application web
Découvrez comment appeler les API AEM basées sur OpenAPI à partir d’une application web personnalisée à l’aide de l’authentification de l’application Web OAuth.
Appeler l’API à l’aide de l’authentification d’application d’une seule page
Découvrez comment appeler les API AEM basées sur OpenAPI à partir d’une application d’une seule page (SPA) personnalisée à l’aide de l’authentification d’application d’une seule page OAuth.