Guía de la API de Identity Service

Adobe Experience Platform Identity Service manages the cross-device, cross-channel, and near real-time identification of your customers in what is known as an identity graph within Adobe Experience Platform.

Primeros pasos

Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:

  • Identity Service: Resuelve el desafío fundamental que supone la fragmentación de los datos de perfil del cliente. Para ello, combina identidades entre dispositivos y sistemas en los que los clientes interactúan con su marca.
  • Real-time Customer Profile: Proporciona un perfil unificado y de cliente en tiempo real basado en datos agregados de varias fuentes.
  • Experience Data Model (XDM): El marco normalizado por el cual Platform organiza los datos de experiencia del cliente.

Las secciones siguientes proporcionan información adicional que debe conocer o tener disponible para realizar llamadas correctamente al Identity Service API.

Leer llamadas de API de ejemplo

Esta guía proporciona ejemplos de llamadas a la API para demostrar cómo dar formato a las solicitudes. Estas incluyen rutas de acceso, encabezados necesarios y cargas de solicitud con el formato correcto. Sample JSON returned in API responses is also provided. Para obtener información sobre las convenciones utilizadas en la documentación para las llamadas de API de ejemplo, consulte la sección sobre cómo leer llamadas de API de ejemplo en el Experience Platform guía de solución de problemas.

Recopilar valores para encabezados necesarios

Para realizar llamadas a Platform API, primero debe completar la variable tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores para cada uno de los encabezados necesarios en todos los Experience Platform Llamadas de API, como se muestra a continuación:

  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Todos los recursos de Experience Platform están aisladas para entornos limitados virtuales específicos. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}
NOTA

Para obtener más información sobre los entornos limitados en Platform, consulte la documentación general de entorno limitado.

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado adicional:

  • Content-Type: application/json

Enrutamiento basado en regiones

La variable Identity Service La API 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 IMS, se determina y almacena una región dentro del perfil de organización de IMS. Using the correct region with each endpoint ensures that all requests made using the Identity Service API are routed to the appropriate region.

There are two regions currently supported by Identity Service APIs: VA7 and NLD2.

La tabla siguiente muestra rutas de ejemplo que utilizan regiones:

Service Región: VA7 Región: NLD2
Identity Service API https://platform-va7.adobe.io/data/core/identity/ https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API https://platform-va7.adobe.io/data/core/idnamespace/ https://platform-nld2.adobe.io/data/core/idnamespace
NOTA

Las solicitudes realizadas sin especificar una región pueden dar como resultado que las llamadas se dirijan a una región incorrecta o que las llamadas fallen de forma inesperada.

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 asistencia.

Using the Identity Service API

Identity parameters used in these services can be expressed in one of two ways; composite or XID.

Composite identities are constructs including both the ID value and namespace. Cuando se utilizan identidades compuestas, el área de nombres se puede proporcionar mediante cualquiera de los nombres (namespace.code) o ID (namespace.id).

Cuando persiste una identidad, Identity Service genera y asigna un ID a esa identidad, denominada 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 [ns o nsid] 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 abarcan toda la funcionalidad del Identity Service API. Para obtener la API completa, consulte la Referencia de la API de Swagger.

NOTA

Todas las identidades devueltas se encuentran en un formulario XID nativo cuando se utiliza XID nativo en la solicitud. Se recomienda utilizar el formulario ID/namespace. Para obtener más información, consulte la sección sobre obtención del XID para una identidad.

Pasos siguientes

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

En esta página