Show Menu
TEMAS×

Guía para desarrolladores de API de servicio de identidad

El servicio de identidad de Adobe Experience Platform administra la identificación entre dispositivos, entre canales y casi en tiempo real de sus clientes en lo que se conoce como gráfico de identidad dentro de Adobe Experience Platform.

Primeros pasos

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:
  • Servicio de identidad: Resuelve el desafío fundamental que plantea la fragmentación de los datos de perfil de los clientes. Para ello, combina identidades entre dispositivos y sistemas en los que los clientes interactúan con su marca.
  • Perfil del cliente en tiempo real: Proporciona un perfil de cliente unificado en tiempo real basado en datos agregados de varias fuentes.
  • Modelo de datos de experiencia (XDM) : El marco estandarizado por el cual Platform organiza los datos de experiencia del cliente.
Las secciones siguientes proporcionan información adicional que deberá conocer o tener disponible para realizar llamadas exitosas a la API de servicio de identidad.

Leer llamadas de API de muestra

Esta guía proporciona ejemplos de llamadas a API para mostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados requeridos y cargas de solicitud con el formato adecuado. También se proporciona el JSON de muestra devuelto en las respuestas de API. Para obtener más información sobre las convenciones utilizadas en la documentación de las llamadas de API de muestra, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas de la plataforma de experiencia.

Recopilar valores para encabezados necesarios

Para realizar llamadas a las API de plataforma, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas de API de la plataforma de experiencia, como se muestra a continuación:
  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Todos los recursos de la plataforma de experiencia están aislados en entornos limitados virtuales específicos. Todas las solicitudes a las API de plataforma requieren un encabezado que especifique el nombre del simulador para pruebas en el que tendrá lugar la operación:
  • x-sandbox-name: {SANDBOX_NAME}
Para obtener más información sobre los entornos limitados en la plataforma, consulte la documentación general del entorno limitado.
Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado adicional:
  • Content-Type: application/json

enrutamiento basado en la región

La API de servicio de identidad emplea extremos específicos de la región que requieren la inclusión de un {REGION} como parte de la ruta de solicitud. Durante el aprovisionamiento de la organización de IMS, se determina y almacena una región dentro del perfil de organización de IMS. El uso de la región correcta con cada extremo garantiza que todas las solicitudes realizadas mediante la API de servicio de identidad se dirijan a la región adecuada.
Existen dos regiones actualmente admitidas por las API de servicio de identidad: VA7 y NLD2.
La siguiente tabla muestra las rutas de ejemplo que utilizan regiones:
Service
Región: VA7
Región: NLD2
API de servicio de identidad
https://platform-va7.adobe.io/data/core/identity/
https://platform-nld2.adobe.io/data/core/identity/
API de Área de nombres de identidad
https://platform-va7.adobe.io/data/core/idnamespace/
https://platform-nld2.adobe.io/data/core/idnamespace
Las solicitudes realizadas sin especificar una región pueden dar como resultado un enrutamiento de llamadas a la región incorrecta o provocar un error inesperado en las llamadas.
Si no puede localizar la región dentro de su perfil de organización de IMS, póngase en contacto con el administrador del sistema para obtener ayuda.

Uso de la API de servicio de identidad

Los parámetros de identidad utilizados en estos servicios pueden expresarse de dos maneras: compuesto o XID.
Las identidades compuestas son construcciones que incluyen tanto el valor de ID como la Área de nombres. Cuando se utilizan identidades compuestas, la Área de nombres se puede proporcionar con el nombre ( namespace.code ) o el ID ( namespace.id ).
Cuando persiste una identidad, el servicio de identidad genera y asigna un ID a esa identidad, denominado ID nativo o XID. Todas las variaciones de las API de clúster y asignación admiten tanto identidades compuestas como XID en sus solicitudes y respuestas. Se requiere uno de los parámetros, xid o combinación de # y id para usar estas API.
Para limitar la carga útil en las respuestas, las API adaptan sus respuestas al tipo de construcción de identidad utilizada. Es decir, si pasa XID, las respuestas tendrán XID, si pasa identidades compuestas, la respuesta seguirá la estructura utilizada en la solicitud.
Los ejemplos de este documento no cubren la funcionalidad completa de la API de servicio de identidad. Para obtener la API completa, consulte la Referencia de API de Swagger.
Todas las identidades devueltas estarán en el formulario XID nativo cuando se utilice XID nativo en la solicitud. Se recomienda utilizar el formulario de ID/Área de nombres. Para obtener más información, consulte la sección sobre la obtención del XID para una identidad .

Pasos siguientes

Ahora que ha recopilado las credenciales necesarias, puede seguir leyendo el resto de la guía para desarrolladores. Cada sección proporciona información importante sobre los extremos y muestra ejemplos de llamadas de API para realizar operaciones de CRUD. Cada llamada incluye el formato general de API, una solicitud de muestra que muestra los encabezados y las cargas útiles con el formato adecuado, y una respuesta de ejemplo para una llamada correcta.