DocumentaciónExperience PlatformConfiguración de Developer Console y Postman

Configurar Developer Console y Postman

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Principiante
  • Intermedio
  • Desarrollador

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

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

Platform se crea primero según la API. Aunque también existen opciones de interfaz para todas las tareas principales, es posible que desee utilizar la API de Platform en algún momento. Por ejemplo, para introducir datos, mover elementos entre entornos limitados, automatizar tareas rutinarias o utilizar nuevas funciones de Platform antes de crear la interfaz de usuario.

Es posible que los arquitectos de datos y los ingenieros de datos tengan que usar la API de Platform fuera de este tutorial.

Permisos necesarios

En la lección Configurar permisos, configuró todos los controles de acceso necesarios para completar esta lección.

Configuración de Adobe Developer Console

Adobe Developer Console es el destino del desarrollador para acceder a las API y SDK de Adobe, escuchar eventos casi en tiempo real, ejecutar funciones en tiempo de ejecución o crear complementos o aplicaciones de App Builder. Lo utilizará para acceder a la API de Experience Platform. Para obtener más información, consulte la documentación de Adobe Developer Console

  1. Cree una carpeta en su equipo local llamada Luma Tutorial Assets para los archivos utilizados en el tutorial.

  2. Abrir Adobe Developer Console

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

  4. Seleccione Crear nuevo proyecto en el menú de Inicio rápido.

    Crear nuevo proyecto

  5. En el proyecto recién creado, seleccione el botón Editar proyecto

  6. Cambie Project Title a Luma Tutorial API Project (agregue su nombre al final, si varias personas de su compañía realizan este tutorial)

  7. Seleccionar Guardar

    Configuración de la API del proyecto Adobe Developer Console

  8. Seleccionar Agregar API

    Configuración de la API del proyecto Adobe Developer Console

  9. Filtre la lista seleccionando Adobe Experience Platform

  10. En la lista de API disponibles, seleccione API de Experience Platform y seleccione Siguiente.

    Configuración de la API del proyecto Adobe Developer Console

  11. Seleccione Servidor a servidor OAuth como credencial y seleccione Siguiente.
    Seleccionar servidor a servidor OAuth

  12. Seleccione el perfil de producto AEP-Default-All-Users y seleccione Guardar la API configurada

    Seleccionar perfil de producto

  13. Ahora se ha creado su proyecto de Developer Console.

  14. En la sección Probar de la página, seleccione Descargar para Postman y, a continuación, seleccione Servidor a servidor OAuth para descargar el archivo json del entorno Postman. Guarde oauth_server_to_server.postman_environment.json en la carpeta Luma Tutorial Assets.

    Configuración de la API del proyecto Adobe Developer Console

Pida a un administrador del sistema que añada la credencial de la API a la función

Para utilizar la credencial de la API e interactuar con el Experience Platform, un administrador del sistema deberá asignar las credenciales de la API a la función creada en la lección anterior. Si no es administrador del sistema, envíeles lo siguiente:

  1. El Nombre de su credencial de API (Credential in Luma Tutorial API Project)

  2. El correo electrónico técnico de la cuenta de su credencial (esto ayudará al administrador del sistema a encontrar la credencial)

    Nombre y Correo electrónico de cuenta técnica de sus credenciales

Estas son las instrucciones para el administrador del sistema:

  1. Iniciar sesión en Adobe Experience Platform

  2. Seleccione Permisos en el panel de navegación izquierdo para acceder a la pantalla de Roles

  3. Abrir el rol Luma Tutorial Platform
    Abrir el rol

  4. Seleccione la ficha Credenciales de API

  5. Seleccionar Agregar credenciales de API
    Agregar credencial

  6. Busque la credencial Credential in Luma Tutorial API Project, filtrando con el correo electrónico de cuenta técnica proporcionado por el participante del tutorial, si la lista es larga

  7. Seleccione la credencial

  8. Seleccionar Guardar

    Agregar credencial

Configuración de Postman

CAUTION
La interfaz de Postman se actualiza regularmente. Las capturas de pantalla de este tutorial se tomaron con Postman v10.15.1 para Mac, pero las opciones de la interfaz pueden haber cambiado.

  1. Descargar e instalar Postman

  2. Abrir Postman y crear un área de trabajo
    Importar entorno

  3. Importar el archivo de entorno json descargado, oauth_server_to_server.postman_environment.json
    Importar entorno

  4. En Postman, seleccione su entorno en la lista desplegable

  5. Seleccione el icono para ver las variables de entorno:

    Cambiar entorno

Añadir el nombre y el ID de inquilino de la zona protegida

Las variables SANDBOX_NAME, TENANT_ID y CONTAINER_ID no se incluyen en la exportación de Adobe Developer Console, por lo que se agregan manualmente:

  1. En Postman, abra Variables de entorno

  2. Seleccione el vínculo Editar a la derecha del nombre del entorno

  3. En el campo Agregar nueva variable, escriba SANDBOX_NAME

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

  5. En el campo Agregar nueva variable, escriba TENANT_ID

  6. Cambie a su explorador web y busque el id de inquilino de su compañía en 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 es diferente:

    Obteniendo el id. de inquilino de la URL de la interfaz de Platform

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

  8. Pegue su ID de inquilino en ambos campos de valor

  9. En el campo Agregar nueva variable, escriba CONTAINER_ID

  10. Escriba global en ambos campos de valor

    note note
    NOTE
    CONTAINER_ID es un campo cuyo valor cambiamos varias veces durante el tutorial. Cuando se usa global, la API interactúa con los elementos proporcionados por el Adobe en su cuenta de Platform. Cuando se usa tenant, la API interactúa con sus propios elementos personalizados.

  11. Seleccionar Guardar

    Se agregaron los campos SANDBOX_NAME, TENANT_ID y CONTAINER_ID como variables de entorno

Realizar llamadas de API

Recuperación de un token de acceso

Adobe proporciona un completo conjunto de Postman colecciones para ayudarle a explorar la API de Experience Platform. Estas colecciones están en el repositorio GitHub de muestras de Adobe Experience Platform Postman. Debe marcar este repositorio, ya que lo utilizará varias veces a lo largo de este tutorial y más tarde al implementar Experience Platform para su propia compañía.

La primera colección funciona con las API del servicio Identity Management de Adobe (IMS). Es una forma cómoda de recuperar un token de acceso desde Postman.

Para generar el token de acceso:

  1. Descargue la colección de API del servicio Identity Management en su carpeta Luma Tutorial Assets

  2. Importar la colección en Postman

  3. Seleccione la solicitud oAuth: Solicitar token de acceso y seleccione Enviar

  4. Debe obtener una respuesta 200 OK con un token de acceso en la respuesta

    Solicitar los tokens

  5. El token de acceso debe almacenarse automáticamente como la variable de entorno ACCESS_TOKEN de su entorno Postman.

    Postman

Interacción con una API de Platform

Ahora vamos a hacer una llamada a la API de Platform para confirmar que hemos configurado todo correctamente.

Abra las colecciones de Experience Platform Postman en GitHub. Hay muchas colecciones en esta página para varias API de plataforma. Recomiendo encarecidamente marcarlo como favorito.

Ahora, vamos a hacer nuestra primera llamada de API:

  1. Descargue la colección de API de Registro de esquemas en su carpeta Luma Tutorial Assets
  2. Importarlo en Postman
  3. Abra API de Registro de esquemas > Esquemas > Enumerar esquemas
  4. Observe las pestañas Params y Headers y observe cómo incluyen algunas de las variables de entorno que ingresamos anteriormente.
  5. Observe que el campo Encabezados > Aceptar valor está establecido en application/vnd.adobe.xed-id+json. Las API de Registro de esquemas requieren uno de estos valores de encabezado Aceptar especificados que proporcionan formatos diferentes en la respuesta.
  6. Seleccione Enviar para realizar su primera llamada a la API de Platform.

Esperamos que haya obtenido una respuesta correcta 200 OK que contenga una lista de los esquemas XDM disponibles proporcionados por el Adobe en su zona protegida, como se muestra a continuación.

Primera llamada API en Postman

Si la llamada no se realizó 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 se queda atascado, solicite ayuda en el Foro de la comunidad o use el enlace que se encuentra en la parte derecha de esta página para "Registrar un problema".

Con los permisos de plataforma, la zona protegida y Postman configurados, está listo para modelar datos en esquemas.

recommendation-more-help
513160b6-bf42-4c58-abdd-4f817b1cccad