Autenticar y acceder a las API Experience Platform

Este documento proporciona un tutorial paso a paso para obtener acceso a una cuenta de desarrollador de Adobe Experience Platform con el fin de realizar llamadas a las API Experience Platform.

Autenticar para realizar llamadas a la API

Para mantener la seguridad de sus aplicaciones y usuarios, todas las solicitudes a las API de Adobe I/O deben autenticarse y autorizarse mediante estándares como OAuth y Tokens web JSON (JWT). A continuación, el JWT se utiliza junto con información específica del cliente para generar su token de acceso personal.

Este tutorial cubre los pasos de autenticación mediante la creación de un token de acceso descritos en el siguiente diagrama de flujo:

Requisitos previos

Para realizar correctamente llamadas a las API Experience Platform , necesita lo siguiente:

  • Una organización de IMS con acceso a Adobe Experience Platform
  • Una cuenta de Adobe ID registrada
  • Un administrador de Admin Console para agregarlo como desarrollador y usuario para un producto.

En las siguientes secciones se explican los pasos para crear un Adobe ID y convertirse en desarrollador y usuario de una organización.

Creación de un Adobe ID

Si no dispone de un Adobe ID, puede crearlo siguiendo estos pasos:

  1. Vaya a Adobe Developer Console
  2. Seleccione crear una nueva cuenta
  3. Completar el proceso de registro

Conviértase en desarrollador y usuario de Experience Platform para una organización

Antes de crear integraciones en Adobe I/O, la cuenta debe tener permisos de desarrollador para un producto en una organización de IMS. Encontrará información detallada sobre las cuentas de desarrollador en Admin Console en el documento de asistencia para administrar desarrolladores.

Obtener acceso de desarrollador

Póngase en contacto con un administrador de Admin Console de su organización para agregarle como desarrollador para uno de los productos de su organización mediante Admin Console.

El administrador debe asignarle como desarrollador a al menos un perfil de producto para continuar.

Una vez que se le asigne como desarrollador, tendrá privilegios de acceso para crear integraciones en Adobe I/O. Estas integraciones son una canalización de aplicaciones y servicios externos a la API de Adobe.

Obtener acceso de los usuarios

El administrador de Admin Console también debe agregarle al producto como usuario.

Al igual que el proceso para añadir un desarrollador, el administrador debe asignarle al menos un perfil de producto para continuar.

Generar credenciales de acceso en Adobe Developer Console

NOTA

Si está siguiendo este documento desde la Guía para desarrolladores de Privacy Service, ahora puede regresar a esa guía para generar las credenciales de acceso exclusivas de Privacy Service.

Con Adobe Developer Console, debe generar las tres credenciales de acceso siguientes:

  • {IMS_ORG}
  • {API_KEY}
  • {ACCESS_TOKEN}

Los {IMS_ORG} y {API_KEY} solo deben generarse una vez y pueden reutilizarse en futuras llamadas a la API Platform. Sin embargo, el {ACCESS_TOKEN} es temporal y debe regenerarse cada 24 horas.

Los pasos se detallan a continuación.

Configuración única

Vaya a Adobe Developer Console e inicie sesión con su Adobe ID. A continuación, siga los pasos descritos en el tutorial sobre la creación de un proyecto vacío en la documentación de Adobe Developer Console.

Una vez creado un nuevo proyecto, seleccione Agregar API en la pantalla Información general del proyecto.

Aparece la pantalla Add an API. Seleccione el icono del producto para Adobe Experience Platform y, a continuación, elija API de Experience Platform antes de seleccionar Siguiente.

Una vez que haya seleccionado Experience Platform como la API que se agregará al proyecto, siga los pasos descritos en el tutorial sobre la adición de una API a un proyecto mediante una cuenta de servicio (JWT) (a partir del paso "Configurar API") para finalizar el proceso.

Una vez añadida la API al proyecto, la página Información general del proyecto muestra las siguientes credenciales que son necesarias en todas las llamadas a las API Experience Platform:

  • {API_KEY} (ID de cliente)
  • {IMS_ORG} (ID de organización)

Autenticación para cada sesión

La credencial requerida final que debe recopilar es su {ACCESS_TOKEN}. A diferencia de los valores de {API_KEY} y {IMS_ORG}, se debe generar un nuevo token cada 24 horas para continuar usando las API Platform.

Para generar un {ACCESS_TOKEN} nuevo, siga los pasos para generar un token JWT en la guía de credenciales de Developer Console.

Probar credenciales de acceso

Una vez que haya recopilado las tres credenciales necesarias, puede intentar realizar la siguiente llamada de API. Esta llamada enumerará todas las clases Experience Data Model (XDM) dentro del contenedor global del Registro de esquemas:

Formato de API

GET /global/classes

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'

Respuesta

Si su respuesta es similar a la que se muestra a continuación, sus credenciales son válidas y funcionan. (Esta respuesta se ha truncado para el espacio).

{
  "results": [
    {
        "title": "XDM ExperienceEvent",
        "$id": "https://ns.adobe.com/xdm/context/experienceevent",
        "meta:altId": "_xdm.context.experienceevent",
        "version": "1"
    },
    {
        "title": "XDM Individual Profile",
        "$id": "https://ns.adobe.com/xdm/context/profile",
        "meta:altId": "_xdm.context.profile",
        "version": "1"
    }
  ]
}

Uso de Postman para autenticación JWT y llamadas de API

Postmanes una herramienta popular para trabajar con las API de RESTful. Esta publicación media describe cómo configurar un postman para que realice automáticamente la autenticación JWT y la utilice para consumir las API de Adobe Experience Platform.

Pasos siguientes

Al leer este documento, ha recopilado y probado correctamente sus credenciales de acceso para las API Platform. Ahora puede seguir los ejemplos proporcionados en la guía de introducción para las API de plataforma. Esta guía contiene vínculos a las guías de API para cada servicio de Platform y proporciona información adicional. en errores, Postman y JSON.

Además de los valores de autenticación recopilados en este tutorial, muchas API Platform también requieren que se proporcione un {SANDBOX_NAME} válido como encabezado. Consulte la información general de los entornos limitados para obtener más información.

En esta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
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