Traitement des API synchrones de communication d’AEM Forms as a Cloud Service

Connexion à Adobe Cloud Manager

1. Accédez à my.cloudmanager.adobe.com
2. Connexion avec votre Adobe ID

Accéder à la présentation du programme

1. Sélectionnez votre programme dans la liste. Vous êtes redirigé vers la page Aperçu du programme .

Rechercher les détails de l’environnement

1. Sélectionnez l’icône ellipsis(…) en regard du nom de l’environnement, puis cliquez sur Mettre à jour

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

   

Recherchez la section Repository

1. Sur la page Présentation du programme, cliquez sur l’onglet Référentiels

2. Recherchez le nom du référentiel et cliquez sur le menu représentant des points de suspension (…)

3. Copiez l’URL du référentiel.

   note note
   NOTE
   Le format de l’URL est généralement https://git.cloudmanager.adobe.com/<org>/<program>/

Cloner À L’Aide De La Commande Git

1. Ouvrez l’invite de commande ou le terminal

2. Exécutez la commande git clone pour cloner le référentiel Git.

   code language-bash
   git clone [repository-url]

   note note
   NOTE
   Pour cloner le référentiel Git, utilisez les informations d’identification fournies par Adobe Cloud Manager.

   Par exemple, pour cloner votre référentiel Git, exécutez la commande suivante :

   code language-bash
   https://git.cloudmanager.adobe.com/formsinternal01/AEMFormsInternal-ReleaseSanity-p43162-uk59167/

   

Connexion à Adobe Cloud Manager

1. Accédez à my.cloudmanager.adobe.com
2. Connexion avec votre Adobe ID

Accéder à la présentation du programme
Sélectionnez votre programme dans la liste. Vous êtes redirigé vers la page Aperçu du programme .

Accès et affichage de l’environnement AEM Cloud Service

Vous pouvez afficher les détails de l’environnement AEM Cloud Service ou y accéder à l’aide de l’une des deux options suivantes :

• Option 1 : À Partir De La Page Aperçu

  1. Sur la page Aperçu du programme

  2. Cliquez sur « Environnements » dans le menu de gauche. Vous pouvez voir une liste de tous les environnements

     

  3. Cliquez sur le nom de l’environnement pour en afficher les détails

     

• Option 2 : À Partir De La Section Environnements

  1. Sur la page Aperçu du programme

  2. Recherchez la section Environnements

  3. Cliquez sur « Tout afficher » pour afficher tous les environnements

  4. Cliquez sur le menu points de suspension (…) en regard de l’environnement
     

  5. Sélectionnez « Afficher les détails »

     

Recherchez Votre Point D’Entrée AEM Forms

Sur la page de détails Environnement, notez les informations suivantes :

URL du service de création

• URL : https://author-pXXXXX-eYYYYY.adobeaemcloud.com
• Compartiment : author-pXXXXX-eYYYY
  Exemple : https://author-p43162-e177398.adobeaemcloud.com

URL du service de publication

• URL : https://publish-pXXXXX-eYYYYY.adobeaemcloud.com
• Compartiment : publish-pXXXXX-eYYYY
  Exemple : https://publish-author-p43162-e177398.adobeaemcloud.com

Accéder à Adobe Developer Console

1. Accéder à Adobe Developer Console
2. Connexion avec votre Adobe ID

Créer un projet

1. Dans la section Démarrage rapide, cliquez sur Créer un projet

2. Un nouveau projet est créé avec un nom par défaut

   

3. Cliquez sur Modifier le projet dans le coin supérieur droit

   

4. Fournissez un nom significatif (par exemple, « projet de formulaire »).

5. Cliquer sur Enregistrer

   

Cliquez sur Ajouter une API

Sélectionnez API de communication Forms

1. Dans la boîte de dialogue Ajouter une API, filtrez par Experience Cloud
2. Sélectionnez « API de communication Forms »

Sélectionnez la méthode d’authentification OAuth de serveur à serveur

Cliquez sur Ajouter une API

• Dans votre projet, cliquez sur le bouton Ajouter une API

Sélectionnez l’API de diffusion et d’exécution AEM Forms

• Dans la boîte de dialogue Ajouter une API, filtrez par Experience Cloud
• Sélectionnez « API de diffusion et d’exécution AEM Forms »
• Cliquer sur Suivant

Méthode d’authentification

• Sélectionnez la méthode d’authentification OAuth de serveur à serveur.

Sélectionnez le profil de produit approprié en fonction du niveau d’accès requis :

Sélectionnez le profil de produit qui correspond à votre URL de service de création (https://author-pXXXXX-eYYYYY.adobeaemcloud.com). Par exemple : sélectionnez https://author-pXXXXX-eYYYYY.adobeaemcloud.com.

Cliquez sur Save configured API (Enregistrer l’API configurée). L’API et le profil de produit sont ajoutés au projet

Accéder À Vos Informations D’Identification

1. Accédez à votre projet dans Adobe Developer Console
2. Cliquez sur les informations d’identification OAuth de serveur à serveur
3. Consultez la section Informations d’identification

Enregistrer les informations d’identification de l’API

API Credentials:
================
Client ID: <your_client_id>
Client Secret: <your_client_secret>
Technical Account ID: <tech_account_id>
Organization ID: <org_id>
Scopes: AdobeID,openid,read_organizations

Accédez à votre projet

1. Dans Adobe Developer Console, ouvrez votre projet
2. Cliquez sur OAuth de serveur à serveur

Générer un jeton d’accès

1. Cliquez sur le bouton Générer un jeton d’accès » dans la section API de votre projet
2. Copier le jeton d’accès généré

Rechercher ou créer un répertoire de configuration

1. Accédez au référentiel de projet AEM cloné, puis au dossier config .
2. S’il n’existe pas, créez-le au niveau racine du projet :

mkdir config

Créez un fichier nommé api.yaml dans le répertoire config :

touch config/api.yaml

Ajoutez le code suivant dans le fichier api.yaml :

kind: "API"
version: "1"
metadata:
envTypes: ["dev"]  # or ["prod", "stage"] for production environments
data:
allowedClientIDs:
    author:
    - "<your_client_id>"
    publish:
    - "<your_client_id>"
    preview:
    - "<your_client_id>"

Les paramètres de configuration sont expliqués ci-dessous :

• kind : toujours définie sur "API" (identifie cela comme une configuration d'API)

• version : version de l’API, généralement "1" ou "1.0"

• envTypes : tableau des types d’environnements auxquels s’applique cette configuration.

  • ["dev"] - Environnements de développement uniquement
  • ["stage"] - Environnements d’évaluation uniquement
  • ["prod"] - Environnements de production uniquement

• allowedClientIDs : ID de client autorisés à accéder à votre instance AEM

  • author : ID de client pour le niveau de création
  • publish : ID de client pour le niveau de publication
  • preview : ID de client pour le niveau d’aperçu

Par exemple, ajoutez le allowedClientIDs en tant que 6bc4589785e246eda29a545d3ca55980 et envTypes en tant que dev :

Valider et envoyer les modifications

1. Accédez au dossier racine du référentiel cloné et exécutez les commandes ci-dessous :

    git add config/api.yaml
    git commit -m "Whitelist client id for api invocation"
    git push origin <your-branch>

Configurer le pipeline

1. Connexion à Cloud Manager

   1. Accédez à my.cloudmanager.adobe.com
   2. Connexion avec votre Adobe ID

2. Accédez à votre programme
   Sélectionnez votre programme dans la liste et vous êtes redirigé vers la page Aperçu du programme .

3. Recherchez la carte Pipelines

   1. Recherchez la vignette Pipelines dans la page Aperçu du programme .
   2. Cliquez sur bouton « Ajouter »

4. Sélectionner le type de pipeline

   • Pour Les Environnements De Développement : Sélectionnez « Ajouter Un Pipeline Hors Production ». Les pipelines hors production sont destinés aux environnements de développement et intermédiaires

   • Pour Les Environnements De Production : Sélectionnez « Ajouter Un Pipeline De Production ». Les pipelines de production nécessitent des approbations supplémentaires

     note note
     NOTE
     Dans ce cas, créez un pipeline hors production, car un environnement de développement est disponible.

5. Configurer le pipeline - Onglet Configuration

   Dans l’onglet Configuration :

   a. Type de pipeline

   • Sélectionnez Pipeline de déploiement

   b. Nom du pipeline

   • Attribuez un nom explicite, par exemple, « api-config-pipieline » au pipeline.

   c. Déclencheur de déploiement

   • Manuel : le déploiement n’est effectué que lorsqu’il est déclenché manuellement (recommandé pour la configuration initiale)
   • Lors des modifications Git : déploiement automatique lorsque les modifications sont transmises à la branche

   d. Comportement en cas d’échecs de mesures importants

   • Demander à chaque fois : demande d’action en cas d’échec (par défaut)
   • Échec immédiat : échec automatique du pipeline en cas d’échec des mesures
   • Continuer immédiatement : continuer malgré les échecs

   e. Cliquez sur « Continuer » pour accéder à l’onglet Code Source

   

6. Configurer le pipeline - Onglet Code Source

   Dans l'onglet Code Source :

   a. Type de déploiement

   • Sélectionnez « Déploiement ciblé »

   b. Options de déploiement

   • Sélectionnez « Config » (déployer les fichiers de configuration uniquement). Il indique à Cloud Manager qu’il s’agit d’un déploiement de configuration.

   c. Sélectionner un environnement de déploiement éligible

   • Choisissez l’environnement dans lequel vous souhaitez déployer la configuration. Dans ce cas, il s’agit d’un environnement dev.

   d. Définition des détails du code Source

   • Référentiel : sélectionnez le référentiel contenant votre fichier api.yaml. Par exemple, sélectionnez le référentiel AEMFormsInternal-ReleaseSanity-p43162-uk59167.
   • Branche Git : sélectionnez votre branche. Par exemple, dans ce cas, notre code est déployé au niveau de la branche main.
   • Emplacement du code : saisissez le chemin d’accès au répertoire config. Comme le api.yaml se trouve dans config dossier racine, saisissez /config

   e. Cliquez sur « Enregistrer » pour créer le pipeline

   

Déployer la configuration

Maintenant que le pipeline est créé, déployez votre configuration api.yaml :

1. Dans la présentation des pipelines

   1. Sur la page Aperçu du programme , recherchez la vignette Pipelines
   2. Accédez au pipeline de configuration que vous venez de créer dans la liste. Par exemple, recherchez le nom du pipeline que vous avez créé (par exemple, « api-config-pipeline »). Vous pouvez afficher les détails du pipeline, notamment le statut et la dernière exécution.

2. Démarrer le déploiement

   1. Cliquez sur le bouton « Créer » (ou sur l’icône de lecture ▶) à côté de votre pipeline
   2. Confirmez le déploiement si vous y êtes invité et l’exécution du pipeline commence

   

3. Vérification de la réussite du déploiement

   • Attendez que le pipeline soit terminé.

     • S’il réussit, le statut passe à « Succès » (coche verte ✓).

     • En cas d’échec, le statut est remplacé par « Échec » (✗ croix rouge). Cliquez sur Télécharger les journaux pour afficher les détails de l’erreur.

       

   Vous pouvez maintenant commencer à tester les API Forms Communications. À des fins de test, vous pouvez utiliser le client Postman, curl ou tout autre client REST pour appeler les API .

Accéder à la documentation de l’API

• API Forms : Référence de l’API Forms
• Document Services : Référence de l’API des services de document
  Ouvrez la documentation des API des services de document dans votre navigateur.

Développez la section Génération de documents et sélectionnez ​ Génère un formulaire PDF à remplir à partir d’un modèle XDP ou PDF, éventuellement avec fusion des données.

Dans le volet de droite, cliquez sur Essayer.

Saisissez les valeurs suivantes :

Cliquez sur Envoyer pour appeler l’API

Vérifiez la réponse dans l’onglet Réponse :

• Si le code de réponse est 200, cela signifie que le PDF a été créé avec succès.
• Si le code de réponse est 400, cela signifie que les paramètres de requête sont non valides ou incorrects.
• Si le code de réponse est 500, cela signifie qu’il existe une erreur de serveur interne.

Dans ce cas, le code de réponse est 200, ce qui signifie que le PDF a bien été généré :

Vous pouvez désormais télécharger le PDF créé à l’aide du bouton Télécharger et l’afficher dans la visionneuse PDF :

Ouvrez le cmd/terminal et exécutez la commande :

code .

Le projet s’ouvre alors dans l’éditeur de code.

Mettez à jour le fichier package.json pour ajouter le type à module.

{
"name": "demo-nodejs-generate-pdf",
"version": "1.0.0",
"type": "module",
"main": "index.js",
}

Créer un fichier .env au niveau racine d’un projet

Ajoutez la configuration suivante et remplacez les espaces réservés par les valeurs réelles des informations d’identification OAuth de serveur à serveur du projet ADC.

CLIENT_ID=<ADC Project OAuth Server-to-Server credential ClientID>
CLIENT_SECRET=<ADC Project OAuth Server-to-Server credential Client Secret>
SCOPES=<ADC Project OAuth Server-to-Server credential Scopes>