Configuración de Developer Console y Postman

En esta lección, debe configurar un proyecto en Adobe Developer Console y descargar Postman colecciones para poder empezar a utilizar las API de Platform.

Para completar los ejercicios de API en este tutorial, descargue la aplicación Postman para su sistema operativo. Aunque no es necesario para utilizar las API de Experience Platform, Postman facilita los flujos de trabajo de API y Adobe Experience Platform proporciona decenas de colecciones de Postman para ayudarle a ejecutar llamadas de API y aprender a funcionar. El resto de este tutorial asume algunos conocimientos prácticos de Postman. Para obtener ayuda, consulte la documentación de Postman.

Platform es la API creada primero. Aunque también existen opciones de interfaz para todas las tareas principales, es probable que desee utilizar la API de plataforma en algún momento. Por ejemplo, para ingerir datos, mueva elementos entre entornos limitados, automatice tareas rutinarias o utilice nuevas funciones de Platform antes de crear la interfaz de usuario.

Es posible que los arquitectos de datos y los ingenieros de datos necesiten utilizar la API de plataforma fuera de este tutorial.

Permisos necesarios

En la lección Configurar permisos, configure todos los controles de acceso que necesite para completar esta lección, específicamente:

  • Elemento de permiso Entornos aislados > Luma Tutorial
  • Acceso de rol de desarrollador al perfil de producto Luma Tutorial Platform

Configuración de Adobe Developer Console

  1. Cree una carpeta en el equipo local con el nombre Luma Tutorial Assets. Esta carpeta se utilizará para guardar los archivos utilizados en el tutorial

  2. Abra Adobe Developer Console

  3. Inicie sesión y confirme que se encuentra en la organización correcta

  4. Haga clic en el botón Crear nuevo proyecto en el menú Inicio rápido.

    Crear nuevo proyecto

  5. En el proyecto recién creado, haga clic en el botón Agregar al proyecto y seleccione API

    Configuración de la API del proyecto de Adobe Developer Console

  6. Filtre la lista haciendo clic en Adobe Experience Platform

  7. En la lista de API disponibles, seleccione API de Experience Platform y haga clic en Siguiente.

    Configuración de la API del proyecto de Adobe Developer Console

  8. Para la autenticación desde sistemas externos como Postman, se requiere un par de claves pública y privada. Para generar un nuevo par de teclas, seleccione Option 1 y pulse el botón Generate keypair

    Configuración de la API del proyecto de Adobe Developer Console

  9. Una vez que las claves estén listas, es posible que se le pida que las descargue en su equipo local. Guarde las claves empaquetadas en config.zip en la carpeta Luma Tutorial Assets. Los necesitaremos en el próximo ejercicio.

  10. Una vez generada la clave, la clave pública se agregará automáticamente al proyecto como se muestra en la captura de pantalla. Haga clic en el botón Next.

     Ver después de la clave se genera y se selecciona

  11. Seleccione el perfil de producto Luma Tutorial Platform y haga clic en el botón Guardar API configurada

    Seleccionar perfil de producto

  12. Ahora se ha creado el proyecto de Developer Console.

  13. En la sección Try it out de la página, haga clic en Download for Postman y, a continuación, haga clic en Service Account (JWT) para descargar el archivo json del entorno Postman. Guarde el service.postman_environment.json en la carpeta Luma Tutorial Assets.

    Configuración de la API del proyecto de Adobe Developer Console

    NOTA

    Los administradores del sistema de su organización podrían ver el proyecto como una "integración" en el perfil de producto en Admin Console

    Configuración de la API del proyecto de Adobe Developer Console

Es posible que haya notado que al proyecto se le asignó un número, por ejemplo "Proyecto 12":

  1. Haga clic en el número del proyecto en la ruta

  2. Haga clic en el botón Editar proyecto

  3. Cambie Título del proyecto a Luma Tutorial API Project (añada su nombre al final, si varias personas de su empresa están tomando este tutorial)

  4. Haga clic en el botón Guardar.

    Configuración de la API del proyecto de Adobe Developer Console

Configurar Postman

  1. Descargar e instalar Postman

  2. Abra Postman e importe el archivo de entorno json descargado, service.postman_environment.json
    Entorno de importación de Adobe Developer Console

  3. En Postman, seleccione el entorno en el menú desplegable superior derecho y haga clic en el icono eye para ver las variables de entorno. Debería ver que las variables ACCESS_TOKEN, PRIVATE_KEY y JWT_TOKEN están en blanco:

    Configuración de la API del proyecto de Adobe Developer Console

Actualizar el nombre del entorno

Dado que el nombre exportado del entorno desde Developer Console se genera aleatoriamente, démosle rápidamente un nombre más descriptivo para que no confunda los entornos más adelante cuando empiece a trabajar en la implementación real de Platform

  1. Con la pantalla de variables de entorno aún abierta, haga clic en Edit en la parte superior derecha

  2. Actualizar el Nombre de entorno a Luma Tutorial

  3. Deje Manage Environments modal abierto en modo de edición, ya que lo editaremos más en el siguiente paso

    Actualizar el nombre del entorno Postman

Adición de la clave privada

Ahora es el momento de agregar el valor PRIVATE_KEY al entorno Postman.

  1. Extraiga el archivo config.zip descargado que se generó en el ejercicio anterior al crear el proyecto de Developer Console. Tendrá dos archivos:
    • private.key
    • certificate_pub.crt
  2. Abra el archivo private.key en un editor de texto y copie todo el contenido disponible.
  3. En Postman, en el modal Manage Environments > Edit que sigue abierto desde el último ejercicio, pegue los valores copiados delante de PRIVATE_KEY en las columnas Initial Value y Current Value.
  4. Haga clic en el botón Update para guardar PRIVATE_KEY y el nombre del entorno actualizado.
    Clave privada pegada en Postman

Añadir el JWT y los tokens de acceso

Adobe proporciona un completo conjunto de colecciones Postman que le ayudan a explorar la API de Experience Platform. Estas colecciones se encuentran en el repositorio de GitHub Adobe Experience Platform Postman Samples. Debe añadir este repositorio a los marcadores, tal y como lo usará en numerosas ocasiones a lo largo de este tutorial y, posteriormente, a medida que implemente Experience Platform para su propia empresa.

La primera colección funciona con las API de Adobe Identity Management Service (IMS). Es una forma cómoda de rellenar JWT_TOKEN y ACCESS_TOKEN desde Postman para casos de uso que no sean de producción, como completar este tutorial en el simulador de pruebas. Como alternativa, el token de JWT se puede generar en Adobe Developer Console, pero como caduca con regularidad, el uso de esta colección le permitirá actualizarlo sin necesidad de volver a visitar Adobe Developer Console mientras completa este tutorial.

ADVERTENCIA

Como se indica en la colección README🔗 de Adobe I/O Access Token Generation Postman, los métodos de generación indicados son adecuados para usos que no sean de producción. La firma local carga una biblioteca JavaScript desde un host de terceros, y la firma remota envía la clave privada a un servicio web administrado por Adobe. Aunque Adobe no almacena esta clave privada, las claves de producción nunca deben compartirse con nadie.

Para generar los tokens:

  1. Descargue la colección de Generación de tokens de acceso de Developer Console a su carpeta Luma Tutorial Assets

  2. Importar la colección en Postman

  3. Seleccione la solicitud IMS: Generar + autenticación JWT mediante el token de usuario y haga clic en Enviar

    Solicitar los tokens

  4. JWT_TOKEN y ACCESS_TOKEN se rellenarán automáticamente en las variables de entorno de Postman.

    Postman

Agregar el nombre del espacio aislado y el ID del inquilino

Las variables SANDBOX_NAME y TENANT_ID y CONTAINER_ID no se proporcionan en la exportación de entorno desde Adobe Developer Console, por lo que se agregarán manualmente:

  1. En Postman, abra el modal Variables de entorno

  2. Haga clic en el enlace Edit a la derecha del nombre del entorno

  3. En Add new variable field, introduzca SANDBOX_NAME

  4. En ambos campos de valor, escriba luma-tutorial, el nombre que le dimos a nuestro simulador de pruebas en la lección anterior. Si ha utilizado un nombre diferente para el entorno limitado, por ejemplo, luma-tutorial-ignatiusjreilly, asegúrese de utilizar ese valor.

  5. En Add new variable field, introduzca TENANT_ID

  6. Cambie al explorador web y busque el ID de inquilino de su empresa. Para ello, vaya a la interfaz de Experience Platform y extraiga la parte de la URL después del signo @. Por ejemplo, mi id de inquilino es techmarketingdemos pero el suyo será algo diferente:

    Obtención del ID de inquilino desde la URL de la interfaz de Platform

  7. Copie este valor y vuelva a la pantalla Postman Administrar entornos .

  8. Pegar el ID de inquilino en ambos campos de valor

  9. En Add new variable field, introduzca CONTAINER_ID

  10. Introduzca global en ambos campos de valor

    NOTA

    CONTAINER_ID es un campo cuyo valor cambiará varias veces durante el tutorial. Cuando se utiliza global, la API interactuará con los elementos proporcionados por Adobe en su cuenta de Platform. Cuando se utiliza tenant , la API interactuará con sus propios elementos personalizados.

  11. Haga clic en el botón Update para guardar las variables

    Campos SANDBOX_NAME, TENANT_ID y CONTAINER_ID añadidos como variables de entorno

Ahora puede cerrar el modal Administrar entornos .

Realizar una llamada de API de plataforma

Ahora vamos a confirmar que hemos configurado todo correctamente realizando una llamada de API.

Abra el otro grupo de colecciones Postman de Experience Platform en Github, las experience-platform-postman-samples. Hay varias colecciones en esta página relacionadas con diversas funciones de Platform.

Descargaremos colecciones tal y como las necesitamos para este tutorial. Este repositorio de Github le resultará extremadamente útil después de este tutorial, ya que empezará a implementar Platform para su empresa, por lo que le recomiendo que lo añada a un marcador.

Ahora, hagamos nuestra primera llamada de API:

  1. Descargue la colección de API del Registro de esquemas en su carpeta Luma Tutorial Assets
  2. Importarlo en Postman
  3. Abra API del Registro de esquemas > Clases > Enumerar todas las clases del contenedor especificado
  4. Observe las pestañas Params y Headers y observe cómo estas incluyen algunas de las variables de entorno que ingresamos anteriormente.
  5. Haga clic en Headers > Accept value field y cambie a application/vnd.adobe.xed-id+json. La API del Registro de esquemas requiere uno de estos valores de encabezado Accept especificados que proporcionan diferentes formatos en la respuesta.
  6. Haga clic en el botón Send para realizar la primera llamada de API de plataforma.

Esperamos que haya obtenido una respuesta 200 OK exitosa que contenga una lista de las clases XDM estándar disponibles en el entorno limitado, como se muestra a continuación.

Primera llamada de API en Postman

Si la llamada no se ha realizado correctamente, dedique un momento a la depuración utilizando los detalles de respuesta de error de la llamada de API y revise los pasos anteriores. Si realmente está atascado, solicite ayuda en el Foro de la comunidad o use el enlace en el lado derecho de esta página para "Registrar un problema".

Recursos adicionales

Con los permisos de Platform, el simulador de pruebas y la Postman configuración, está listo para modelar los datos en esquemas.

En esta página

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now