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.

Dans cet exemple, l’API AEM Assets utilisant la méthode d’authentification de serveur à serveur est utilisée pour démontrer le processus de configuration. Vous pouvez suivre les mêmes étapes pour d’autres API AEM basées sur OpenAPI.

Le processus général de configuration comprend les étapes suivantes :

  1. Modernisation de l’environnement AEM as a Cloud Service.
  2. Activez l’accès aux API AEM.
  3. Créez un projet Adobe Developer Console (ADC).
  4. Configurez le projet ADC.
  5. Configurez l’instance AEM pour activer la communication du projet ADC.

Modernisation de l’environnement AEM as a Cloud Service modernization-of-aem-as-a-cloud-service-environment

La modernisation de l’environnement AEM as a Cloud Service est une activité unique par environnement qui comprend les étapes suivantes :

  • Mettez à jour vers AEM version  2024.10.18459.20241031T210302Z ou une version ultérieure.
  • Ajoutez-y de nouveaux profils de produit, si l’environnement a été créé avant la version 2024.10.18459.20241031T210302Z.

Mettre à jour l’instance AEM update-aem-instance

Pour mettre à jour l’instance AEM, dans la section Environnements d’Adobe Cloud Manager, sélectionnez l’icône points de suspension en regard du nom de l’environnement, puis sélectionnez l’option Mettre à jour.

Mise à jour de l’instance AEM

Cliquez ensuite sur le bouton Envoyer et exécutez le pipeline full stack suggéré.

Sélectionde la dernière version d’AEM

Dans mon cas, le pipeline full stack est nommé Dev :: Fullstack-Deploy et l’environnement AEM est appelé wknd-program-dev. Vos noms peuvent être différents.

Ajouter de nouveaux profils de produit add-new-product-profiles

Pour ajouter de nouveaux profils de produit à l’instance AEM, dans la section Environnements d’Adobe Cloud Manager, sélectionnez l’icône points de suspension en regard du nom de l’environnement, puis sélectionnez l’option Ajouter des profils de produit.

Ajout de nouveaux profils de produit

Vous pouvez examiner les profils de produit nouvellement ajoutés en cliquant sur l’icône points de suspension à côté du nom de l’environnement et en sélectionnant Gérer l’accès > Créer des profils.

La fenêtre Admin Console affiche les nouveaux profils de produit ajoutés.

Vérification des nouveaux profils de produit

Les étapes ci-dessus complètent la modernisation de l’environnement AEM as a Cloud Service.

Activer l’accès aux API AEM enable-aem-apis-access

La présence des nouveaux profils de produit permet d’activer l’accès à l’API AEM basée sur OpenAPI dans Adobe Developer Console (ADC). Rappelez-vous qu’Adobe Developer Console (ADC) est le hub de développement pour accéder aux API, aux SDK, aux événements en temps réel, aux fonctions sans serveur d’Adobe, etc.

Les profils de produit nouvellement ajoutés sont associés aux Services qui représentent les groupes d’utilisateurs et d’utilisatrices AEM avec des listes de contrôle d’accès (ACL) prédéfinies. Les Services sont utilisés pour contrôler le niveau d’accès aux API AEM.

Vous pouvez également sélectionner ou désélectionner les Services associés au profil de produit pour réduire ou augmenter le niveau d’accès.

Vérifiez l’association en cliquant sur l’icône Afficher les détails à côté du nom du profil de produit.

Vérification des services associés au profil de produit

Activer l’accès aux API AEM Assets enable-aem-assets-apis-access

Par défaut, le service Utilisateurs et utilisatrices de l’API AEM Assets n’est associé à aucun profil de produit. Associons-le au profil de produit Utilisateurs et utilisatrices collaborateurs d’AEM Assets - Création - Programme XXX - Environnement XXX nouvellement ajouté ou à tout autre profil de produit que vous souhaitez utiliser pour l’accès à l’API AEM Assets.

Association du service Utilisateurs et utilisatrices de l’API AEM Assets au profil de produit

Activer l’authentification de serveur à serveur

Pour activer l’authentification de serveur à serveur pour les API AEM souhaitées, la personne configurant l’intégration à l’aide d’Adobe Developer Console (ADC) doit être ajoutée en tant que développeur ou développeuse au profil de produit auquel le service est associé.

Par exemple, pour activer l’authentification de serveur à serveur pour l’API AEM Assets, la personne doit être ajoutée en tant que développeur ou développeuse au profil de produit Utilisateurs et utilisatrices collaborateurs d’AEM Assets - Création - Programme XXX - Environnement XXX.

Association du développeur ou de la développeuse au profil de produit

Après cette association, l’API de création Asset du projet ADC peut configurer l’authentification de serveur à serveur souhaitée et associer le compte d’authentification du projet ADC (créé à l’étape suivante) au profil de produit.

IMPORTANT
L’étape ci-dessus est essentielle pour activer l’authentification de serveur à serveur pour l’API AEM souhaitée. Sans cette association, l’API AEM ne peut pas être utilisée avec la méthode d’authentification de serveur à serveur.

Créer un projet Adobe Developer Console (ADC) adc-project

Le projet ADC permet d’ajouter les API souhaitées, de configurer son authentification et d’associer le compte d’authentification au profil de produit.

Pour créer un projet ADC, procédez comme suit :

  1. Connectez-vous à Adobe Developer Console à l’aide de votre Adobe ID.

    Adobe Developer Console

  2. Dans la section Démarrage rapide, cliquez sur le bouton Créer un projet.

    Création d’un projet

  3. Un projet portant le nom par défaut est créé.

    Projet créé

  4. Modifiez le nom du projet en cliquant sur le bouton Modifier le projet dans le coin supérieur droit. Indiquez un nom significatif et cliquez sur Enregistrer.

    Modification de nom du projet

Configurer le projet ADC configure-adc-project

Après avoir créé le projet ADC, vous devez ajouter les API AEM souhaitées, configurer son authentification et associer le compte d’authentification au profil de produit.

  1. Pour ajouter des API AEM, cliquez sur le bouton Ajouter une API.

    Ajouter une API

  2. Dans la boîte de dialogue Ajouter une API, filtrez par Experience Cloud et sélectionnez l’API AEM souhaitée. Par exemple, dans ce cas, l’API de création Asset est sélectionnée.

    Ajout d’une API AEM

    note tip
    TIP
    Si la carte d’API AEM souhaitée est désactivée et les informations Pourquoi est-ce désactivé ? indiquent le message Licence requise, l’une des raisons peut être que vous n’avez PAS modernisé votre environnement AEM as a Cloud Service. Pour plus d’informations, consultez Modernisation de l’environnement AEM as a Cloud Service.
  3. Ensuite, dans la boîte de dialogue Configurer l’API, sélectionnez l’option d’authentification souhaitée. Par exemple, dans ce cas, l’option d’authentification Serveur à serveur est sélectionnée.

    Sélection de l’authentification

    L’authentification de serveur à serveur est idéale pour les services principaux nécessitant un accès à l’API sans interaction avec l’utilisateur ou l’utilisatrice. Les options d’authentification Application web et Application d’une seule page sont adaptées aux applications nécessitant un accès API au nom des utilisateurs et utilisatrices. Consultez Différence entre les informations d’identification OAuth de serveur à serveur et les informations d’identification d’application web et d’application d’une seule page pour plus d’informations.

    note tip
    TIP
    Si vous ne voyez pas l’option d’authentification de serveur à serveur, cela signifie que la personne qui configure l’intégration n’est pas ajoutée en tant que développeur ou développeuse au profil de produit auquel le service est associé. Consultez Activer l’authentification de serveur à serveur pour plus d’informations.
  4. Si nécessaire, vous pouvez renommer l’API pour une identification plus facile. À des fins de démonstration, le nom par défaut est utilisé.

    Renommage des informations d’identification

  5. Dans ce cas, la méthode d’authentification est OAuth serveur à serveur, vous devez donc associer le compte d’authentification au profil de produit. Sélectionnez le profil de produit Utilisateurs et utilisatrices collaborateurs d’AEM Assets - Création - Programme XXX - Environnement XXX et cliquez sur Enregistrer.

    Sélectionner le profil de produit

  6. Examinez l’API AEM et la configuration de l’authentification.

    Configuration d’API AEM

    Configuration d’authentification

Si vous choisissez la méthode d’authentification Application Web OAuth ou application d’une seule page OAuth, l’association de profil de produit n’est pas demandée, mais l’URI de redirection de l’application est requis. L’URI de redirection d’application est utilisé pour rediriger la personne vers l’application après authentification avec un code d’autorisation. Les tutoriels de cas d’utilisation pertinents décrivent ces configurations spécifiques à l’authentification.

Configurer l’instance AEM pour activer la communication du projet ADC configure-aem-instance

Pour permettre à l’ID client du projet ADC de communiquer avec l’instance AEM, vous devez configurer l’instance AEM.

Pour ce faire, définissez la configuration de l’API dans un fichier YAML et déployez-la à l’aide du pipeline de configuration dans Cloud Manager. Le fichier YAML définit les ID clients autorisés du projet ADC qui peuvent communiquer avec l’instance AEM.

  1. Dans le projet AEM, recherchez ou créez le fichier api.yaml à partir du dossier config.

    Localisation de l’API YAML {width="500"}

  2. Ajoutez la configuration suivante au fichier api.yaml.

    code language-yaml
    kind: "API"
    version: "1.0"
    metadata:
        envTypes: ["dev", "stage", "prod"]
    data:
        allowedClientIDs:
            author:
            - "<ADC Project's Credentials ClientID>"
    

    Remplacez <ADC Project's Credentials ClientID> par l’ID client réel de la valeur des informations d’identification du projet ADC. Le point d’entrée d’API utilisé dans ce tutoriel est disponible uniquement au niveau création, mais pour les autres API, la configuration YAML peut également avoir un nœud publication ou aperçu.

    note caution
    CAUTION
    À des fins de démonstration, le même ID client est utilisé pour tous les environnements. Il est recommandé d’utiliser des ID clients distincts par environnement (développement, évaluation, production) pour une meilleure sécurité et un meilleur contrôle.
  3. Validez les modifications de configuration et envoyez les modifications au référentiel Git distant auquel le pipeline Cloud Manager est connecté.

  4. Déployez les modifications ci-dessus à l’aide du pipeline de configuration dans Cloud Manager. Notez que le fichier api.yaml peut également être installé dans un RDE à l’aide de l’outil de ligne de commande.

    Déploiement YAML

Étapes suivantes

Une fois l’instance AEM configurée pour activer la communication de projet ADC, vous pouvez commencer à utiliser les API AEM basées sur OpenAPI. 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

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.

En savoir plus

Appeler l’API à l’aide de l’authentification de l’application web

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.

En savoir plus

Appeler l’API à l’aide de l’authentification par application d’une seule page

Appeler l’API à l’aide de l’authentification par 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 du flux PKCE OAuth 2.0.

En savoir plus

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69