Procesamiento de API sincrónicas de comunicaciones de AEM Forms as a Cloud Service

Iniciar sesión en Adobe Cloud Manager

1. Vaya a my.cloudmanager.adobe.com
2. Inicie sesión con su Adobe ID

Ir a la descripción general del programa

1. Seleccione el programa en la lista. Se le redirigirá a la página Información general del programa

Buscar detalles del entorno

1. Seleccione el icono ellipsis(…) junto al nombre del entorno y haga clic en Actualizar

2. Haga clic en el botón Enviar y ejecute la canalización de pila completa sugerida.

   

Busque la sección del repositorio

1. En la página Resumen del programa, haga clic en la ficha Repositorios

2. Busque el nombre del repositorio y haga clic en el menú de puntos suspensivos (…).

3. Copiar la URL del repositorio

   note note
   NOTE
   El formato de dirección URL suele ser https://git.cloudmanager.adobe.com/<org>/<program>/

Clonar con el comando Git

1. Abra el símbolo del sistema o el terminal

2. Ejecute el comando git clone para clonar el repositorio Git.

   code language-bash
   git clone [repository-url]

   note note
   NOTE
   Para clonar el repositorio Git, utilice las credenciales proporcionadas por Adobe Cloud Manager.

   Por ejemplo, para clonar el repositorio Git, ejecute el siguiente comando:

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

   

Iniciar sesión en Adobe Cloud Manager

1. Vaya a my.cloudmanager.adobe.com
2. Inicie sesión con su Adobe ID

Ir a la descripción general del programa
Seleccione el programa en la lista. Se le redirigirá a la página Información general del programa

Acceder y ver el entorno de AEM Cloud Service

Puede ver o acceder a los detalles del entorno de AEM Cloud Service mediante cualquiera de las dos opciones:

• Opción 1: desde la página de información general

  1. En la página Resumen del programa

  2. Haga clic en "Entornos" en el menú del lado izquierdo. Puede ver una lista de todos los entornos

     

  3. Haga clic en el nombre de entorno específico para ver los detalles

     

• Opción 2: desde la sección Entornos

  1. En la página Información general del programa

  2. Busque la sección Entornos

  3. Haga clic en "Mostrar todo" para ver todos los entornos

  4. Haga clic en el menú de puntos suspensivos (…) que está junto al entorno
     

  5. Seleccionar "Ver detalles"

     

Buscar el extremo de AEM Forms

En la página de detalles de Entorno, tenga en cuenta los siguientes detalles:

URL del servicio de creación

• URL: https://author-pXXXXX-eYYYYY.adobeaemcloud.com
• Cubo: author-pXXXXX-eYYYY
  Ejemplo: https://author-p43162-e177398.adobeaemcloud.com

URL del servicio de publicación

• URL: https://publish-pXXXXX-eYYYYY.adobeaemcloud.com
• Contenedor: publish-pXXXXX-eYYYY
  Ejemplo: https://publish-p43162-e177398.adobeaemcloud.com

Acceder a Adobe Developer Console

1. Vaya a Adobe Developer Console
2. Inicie sesión con su Adobe ID

Crear nuevo proyecto

1. En la sección Inicio rápido, haga clic en Crear nuevo proyecto

2. Se crea un nuevo proyecto con un nombre predeterminado

   

3. Haga clic en Editar proyecto en la esquina superior derecha

   

4. Proporcione un nombre significativo (por ejemplo, "formsproject")

5. Haga clic en Guardar.

   

Haga clic en Agregar API

Seleccionar API de comunicación de Forms

1. En el cuadro de diálogo Agregar API, filtrar por Experience Cloud
2. Seleccione "API de comunicación de Forms"

Seleccione el método de autenticación OAuth Server-to-Server

Haga clic en Agregar API

• En su proyecto, haga clic en el botón Agregar API

Seleccionar API de tiempo de ejecución y entrega de AEM Forms

• En el cuadro de diálogo Agregar API, filtrar por Experience Cloud
• Seleccione "API de tiempo de ejecución y entrega de AEM Forms"
• Haga clic en Siguiente

Método de autenticación

• Seleccione el método de autenticación OAuth Server-to-Server.

Seleccione el perfil de producto apropiado según el nivel de acceso requerido:

Seleccione el perfil de producto que coincida con la dirección URL del servicio de creación (https://author-pXXXXX-eYYYYY.adobeaemcloud.com). Por ejemplo: seleccione https://author-pXXXXX-eYYYYY.adobeaemcloud.com.

Haga clic en Guardar API configurada. La API y el perfil de producto se añaden al proyecto

Acceder a sus credenciales

1. Vaya al proyecto en Adobe Developer Console
2. Haga clic en la credencial OAuth de servidor a servidor
3. Ver la sección Detalles de credenciales

Registrar credenciales de 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

Vaya a su proyecto

1. En Adobe Developer Console, abra el proyecto
2. Haga clic en Servidor a servidor de OAuth

Generar token de acceso

1. Haga clic en el botón "Generar token de acceso" en la sección de API del proyecto
2. Copiar el token de acceso generado

Localizar o crear directorio de configuración

1. Vaya al repositorio clonado de AEM Project y luego a la carpeta config
2. Si no existe, créela en el nivel raíz del proyecto:

mkdir config

Cree un nuevo archivo con el nombre api.yaml en el directorio config:

touch config/api.yaml

Agregue el siguiente código al archivo 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>"

A continuación se explican los parámetros de configuración:

• kind: siempre se establece en "API" (lo identifica como una configuración de API)

• versión: versión de API, normalmente "1" o "1.0"

• envTypes: matriz de tipos de entorno donde se aplica esta configuración

  • ["dev"]: solo entornos de desarrollo
  • ["stage"]: solo entornos de ensayo
  • ["prod"] - Solo entornos de producción

• allowedClientID: Los ID de cliente pueden acceder a su instancia de AEM

  • author: ID de cliente para el nivel de author
  • publicar: ID de cliente para el nivel de publicación
  • vista previa: ID de cliente para el nivel de vista previa

Por ejemplo, agregue allowedClientIDs como 6bc4589785e246eda29a545d3ca55980 y envTypes como dev:

Cambios de confirmación y inserción

1. Vaya a la carpeta raíz del repositorio clonado y ejecute los siguientes comandos:

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

Configurar canalización de configuración

1. Iniciar sesión en Cloud Manager

   1. Vaya a my.cloudmanager.adobe.com
   2. Inicie sesión con su Adobe ID

2. Vaya a su programa
   Seleccione el programa de la lista y se le redirigirá a la página Información general del programa

3. Localizar la tarjeta de canalizaciones

   1. Busque la tarjeta Canalizaciones en la página Información general del programa
   2. Haga clic en el botón "Agregar"

4. Seleccionar tipo de canalización

   • Para Entornos De Desarrollo: Seleccione "Agregar Canalización Que No Sea De Producción". Las canalizaciones que no son de producción son para entornos de desarrollo y ensayo

   • Para Entornos De Producción: Seleccione "Agregar Canalización De Producción". Las canalizaciones de producción requieren aprobaciones adicionales

     note note
     NOTE
     En este caso, cree una canalización que no sea de producción, ya que hay un entorno de desarrollo disponible.

5. Configurar canalización: ficha Configuración

   En la ficha Configuración:

   a. Tipo de canalización

   • Seleccionar "Canalización de implementación"

   b. Nombre de canalización

   • Proporcione un nombre descriptivo. Por ejemplo, asigne a la canalización el nombre api-config-pipieline

   c. Déclencheur de implementación

   • Manual: Implementar solo cuando se activa manualmente (recomendado para la configuración inicial)
   • Cambios en Git: Implementar automáticamente cuando los cambios se inserten en la rama

   d. Comportamiento de errores de métricas importantes

   • Preguntar cada vez: Pedir acción si se producen errores (predeterminado)
   • Error inmediato: Error automático de canalización en caso de errores de métricas
   • Continuar inmediatamente: Continuar a pesar de los errores

   e. Haga clic en "Continuar" para continuar con la ficha Código Source

   

6. Configurar canalización: ficha Código Source

   En la ficha Código Source:

   a. Tipo de implementación

   • Seleccione "Implementación de destino"

   b. Opciones de implementación

   • Seleccione "Config" (implementar solo archivos de configuración). Indica a Cloud Manager que se trata de una implementación de configuración.

   c. Seleccionar entorno de implementación elegible

   • Elija el entorno en el que desea implementar la configuración. En este caso, es un entorno dev.

   d. Definir detalles de código Source

   • Repositorio: seleccione el repositorio que contiene el archivo api.yaml. Por ejemplo, seleccione el repositorio AEMFormsInternal-ReleaseSanity-p43162-uk59167.
   • Rama Git: Seleccione su rama. Por ejemplo, en este caso nuestro código se implementa en la rama main.
   • Ubicación del código: escriba la ruta de acceso al directorio config. Como api.yaml se encuentra en la carpeta config en la raíz, escriba /config

   e. Haga clic en "Guardar" para crear la canalización

   

Implementar configuración

Ahora que se ha creado la canalización, implemente la configuración de api.yaml:

1. De la descripción general de canalizaciones

   1. En la página Información general del programa, busque la tarjeta Canalizaciones
   2. Vaya a la canalización de configuración recién creada en la lista. Por ejemplo, busque el nombre de la canalización que ha creado (por ejemplo, "api-config-pipeline"). Puede ver los detalles de la canalización, incluido el estado y la última ejecución.

2. Iniciar la implementación

   1. Haga clic en el botón "Generar" (o en el icono de reproducción ▶) que se encuentra junto a la canalización
   2. Confirme la implementación si se le solicita y comienza la ejecución de la canalización

   

3. Verificar implementación correcta

   • Espere a que se complete la canalización.

     • Si tiene éxito, el estado cambia a "Correcto" (marca de verificación verde ✓).

     • Si falla, el estado cambia a "Fail" (Cruz roja ✗). Haga clic en Descargar registros para ver los detalles del error.

       

   Ahora puede empezar a probar las API de comunicaciones de Forms. Para realizar pruebas, puede utilizar Postman, curl o cualquier otro cliente REST para invocar las API.

Vaya a la documentación de API

• API de Forms: Referencia de API de Forms
• Servicios de documentos: Referencia de API de servicios de documentos
  Abra la documentación de API de servicios de documentos en su explorador.

Expanda la sección Generación de documentos y seleccione Genera un formulario PDF que se puede rellenar a partir de una plantilla XDP o PDF, opcionalmente con la combinación de datos.

En el panel derecho, haga clic en Probar.

Introduzca los siguientes valores:

Haga clic en Enviar para invocar la API

Compruebe la respuesta en la ficha Respuesta:

• Si el código de respuesta es 200, significa que PDF se ha creado correctamente.
• Si el código de respuesta es 400, significa que los parámetros de la solicitud no son válidos o tienen un formato incorrecto.
• Si el código de respuesta es 500, significa que hay un error interno del servidor.

En este caso, el código de respuesta es 200, lo que significa que PDF se ha generado correctamente:

Ahora puedes descargar el PDF creado con el botón Descargar y verlo en el visor de PDF:

Abra cmd/terminal y ejecute el comando:

code .

Se abre el proyecto en el editor de código.

Actualice el archivo package.json para agregar type a module.

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

Crear archivo .env en el nivel raíz de un proyecto

Agregue la siguiente configuración y reemplace los marcadores de posición con los valores reales de la credencial de servidor a servidor OAuth del proyecto 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>