DocumentaciónExperience PlatformConfiguración de Developer Console y Postman

Configurar Developer Console y Postman

Last update: Fri Jun 23 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Principiante
  • Intermedio
  • Desarrollador

En esta lección, debe configurar un proyecto en la consola de Adobe Developer y descargar Postman para que pueda empezar a utilizar las API de Platform.

Para completar los ejercicios de API de este tutorial, haga lo siguiente: descargue la aplicación de Postman para su sistema operativo. Aunque no es necesario para utilizar las API de Experience Platform, Postman facilita los flujos de trabajo de las API y Adobe Experience Platform proporciona decenas 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.

Arquitectos de datos y Ingenieros de datos puede que necesite utilizar la API de Platform fuera de este tutorial.

Permisos necesarios

En el Configuración de permisos Esta lección, ha configurado todos los controles de acceso necesarios para completar esta lección.

Configuración de la consola de Adobe Developer

La consola de Adobe Developer 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 la consola Adobe Developer

  1. Cree una carpeta en el equipo local con el nombre Luma Tutorial Assets para archivos utilizados en el tutorial.

  2. Abra el Consola de Adobe Developer

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

  4. Seleccionar Crear nuevo proyecto in Inicio rápido menú.

    Crear nuevo proyecto

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

  6. Cambie el Título del proyecto hasta Luma Tutorial API Project (añada su nombre al final, si varias personas de su compañía realizan este tutorial)

  7. Seleccione Guardar

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

  8. Seleccionar Añadir API

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

  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 API del proyecto de la consola Adobe Developer

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

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

    Seleccionar perfil de producto

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

  14. En el Pruébelo. de la página, seleccione Descargar para Postman y luego seleccione Servidor a servidor OAuth para descargar Postman archivo json de entorno. Guarde el oauth_server_to_server.postman_environment.json en su Luma Tutorial Assets carpeta.

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

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 de cuenta técnica de sus credenciales (esto ayudará al administrador del sistema a encontrar las credenciales)

    Nombre y Correo electrónico de cuenta técnica de su credencial

Estas son las instrucciones para el administrador del sistema:

  1. Iniciar sesión en Adobe Experience Platform

  2. Seleccionar Permisos en la navegación de la izquierda, que le llevará a la Funciones pantalla

  3. Abra el Luma Tutorial Platform función
    Abra la función

  4. Seleccione el Credenciales de API pestaña

  5. Seleccionar Añadir credenciales de API
    Añadir credencial

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

  7. Seleccione la credencial

  8. Seleccione Guardar

    Añadir 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 cree un espacio de trabajo
    Importar entorno

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

  4. Entrada 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

El SANDBOX_NAME y TENANT_ID y CONTAINER_ID Las variables de no se incluyen en la exportación de la consola de Adobe Developer, por lo que se añaden manualmente:

  1. Entrada Postman, abra el Variables de entorno

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

  3. En el Agregar nuevo campo de variable, introduzca SANDBOX_NAME

  4. En ambos campos de valor, introduzca 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 Agregar nuevo campo de variable, introduzca TENANT_ID

  6. Cambie al explorador web y busque el ID de inquilino de su empresa en la interfaz de Experience Platform y extraiga la parte de la dirección URL después del signo @. Por ejemplo, mi ID de inquilino es techmarketingdemos pero el tuyo es diferente:

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

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

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

  9. En el Agregar nuevo campo de variable, introduzca CONTAINER_ID

  10. Entrar global en ambos campos de valor

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

  11. Seleccione Guardar

    Los campos SANDBOX_NAME, TENANT_ID y CONTAINER_ID se han añadido como variables de entorno

Realizar llamadas de API

Recuperación de un token de acceso

El Adobe proporciona un conjunto completo de Postman colecciones para ayudarle a explorar la API de Experience Platform. Estas colecciones se encuentran en la Adobe Experience Platform Postman Ejemplos Repositorio de GitHub. 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 Recopilación de API del servicio Identity Management a su Luma Tutorial Assets carpeta

  2. Importe la colección en Postman

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

  4. Usted debe conseguir una 200 OK respuesta con un token de acceso en la respuesta

    Solicitar los tokens

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

    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 el Experience Platform Postman colecciones 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 a su Luma Tutorial Assets carpeta
  2. Importarlo en Postman
  3. Abrir API de Registro de Esquemas > Esquemas > Enumerar esquemas
  4. Consulte la Parámetros y Encabezados y observe cómo incluyen algunas de las variables de entorno que ingresamos anteriormente.
  5. Tenga en cuenta que la variable Encabezados > Aceptar campo de valor se establece en application/vnd.adobe.xed-id+json. Las API de Registro de esquemas requieren uno de estos elementos valores de encabezado Aceptar especificados que proporcionan diferentes formatos en la respuesta.
  6. Seleccionar Enviar para realizar su primera llamada a la API de Platform.

Espero que tengas éxito 200 OK Respuesta que contiene una lista de los esquemas XDM disponibles proporcionados por el Adobe en la zona protegida, como se muestra a continuación.

Primera llamada de 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, por favor solicite ayuda en el Foro de la comunidad o utilice el enlace de la derecha de esta página para "Registrar un problema".

Con los permisos de Platform, la zona protegida y Postman configurado, está listo para datos de modelo en esquemas!

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