Identity Service Guía para desarrolladores de API

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

Primeros pasos

Esta guía requiere un conocimiento práctico de los siguientes componentes de Adobe Experience Platform:

  • Identity Service:: 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.
  • Real-time Customer Profile:: Proporciona un perfil de cliente unificado 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 siguientes secciones proporcionan información adicional que deberá conocer o tener disponible para realizar llamadas a la Identity Service API correctamente.

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 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 Experience Platform .

Recopilar valores para encabezados necesarios

Para realizar llamadas a Platform API, primero debe completar el tutorial deautenticación. Al completar el tutorial de autenticación se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas Experience Platform de API, 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 Experience Platform están aislados en entornos limitados virtuales específicos. Todas las solicitudes a Platform las API requieren un encabezado que especifique el nombre del entorno limitado en el que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}
NOTA

Para obtener más información sobre los entornos limitados de Platform, consulte la documentación general delentorno 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 Identity Service 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 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 punto final garantiza que todas las solicitudes realizadas con la Identity Service API se dirijan a la región adecuada.

Actualmente hay dos regiones admitidas por Identity Service las API: VA7 y NLD2.

La siguiente tabla muestra las 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 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 Identity Service API

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 se mantiene una identidad, genera y asigna un ID a esa identidad, denominado ID nativo o XID. Identity Service 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 cubren toda la funcionalidad de la Identity Service API. Para obtener la API completa, consulte la Referencia de API deSwagger.

NOTA

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 de API general, 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.

En esta página