Introducción a las API de Adobe Experience Platform

Adobe Experience Platform se desarrolla con una filosofía de "API primero". Mediante las API de plataforma, puede realizar mediante programación operaciones CRUD básicas (Crear, Leer, Actualizar, Eliminar) con datos, como configurar atributos calculados, acceder a datos o entidades, exportar datos, eliminar datos o lotes innecesarios, etc.

Las API de cada servicio de Experience Platform comparten el mismo conjunto de encabezados de autenticación y utilizan sintaxis similares para sus operaciones de CRUD. La siguiente guía describe los pasos necesarios para comenzar con las API de Platform.

Autenticación y encabezados

Para realizar correctamente llamadas a extremos de Platform, 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 las llamadas a la API de Experience Platform, como se muestra a continuación:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Encabezado de espacio aislado

Todos los recursos del Experience Platform están aislados en entornos limitados virtuales específicos. Las solicitudes a las API de plataforma requieren un encabezado que especifique el nombre del simulador para pruebas en el que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}

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

Encabezado de tipo contenido

Todas las solicitudes con una carga útil en el cuerpo de la solicitud (como llamadas de POST, PUT y PATCH) deben incluir un encabezado Content-Type. Los valores aceptados son específicos de cada extremo de API. Si se necesita un valor Content-Type específico para un extremo, su valor se mostrará en las solicitudes de API de ejemplo proporcionadas por las guías de API para servicios de Platform individuales.

Aspectos básicos de la API del Experience Platform

Las API de Adobe Experience Platform emplean varias tecnologías subyacentes y sintaxis que son importantes de comprender para administrar eficazmente los recursos de Platform.

Para obtener más información sobre las tecnologías de API subyacentes que utiliza Platform, incluidos ejemplos de objetos de esquema JSON, visite la guía Fundamentos de la API del Experience Platform.

Colecciones Postman para API de Experience Platform

Postman es una plataforma de colaboración para el desarrollo de API que le permite configurar entornos con variables preestablecidas, compartir colecciones de API, optimizar solicitudes CRUD y mucho más. La mayoría de los servicios de API de plataforma tienen colecciones Postman que se pueden utilizar para ayudar a realizar llamadas de API.

Para obtener más información sobre Postman, incluido cómo configurar un entorno, una lista de colecciones disponibles y cómo importar colecciones, visite la documentación de Platform Postman.

Leyendo llamadas de API de ejemplo

Los formatos de solicitud varían según la API de plataforma que se utilice. La mejor manera de estructurar las llamadas de API es seguir los ejemplos proporcionados en la documentación del servicio de Platform en particular que está utilizando.

La documentación de Experience Platform muestra las llamadas de API de ejemplo de dos maneras diferentes. En primer lugar, la llamada se presenta en su formato API, una representación de plantilla que muestra únicamente la operación (GET, POST, PUT, PATCH, DELETE) y el punto final que se está utilizando (por ejemplo, /global/classes). Algunas plantillas también muestran la ubicación de las variables para ayudar a ilustrar cómo se debe formular una llamada, como GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}.

A continuación, las llamadas se muestran como comandos cURL en una Solicitud, que incluye los encabezados necesarios y la "ruta base" completa necesaria para interactuar correctamente con la API. La ruta base debe añadirse previamente a todos los extremos. Por ejemplo, el punto final /global/classes antes mencionado se convierte en https://platform.adobe.io/data/foundation/schemaregistry/global/classes. Verá el formato de API / patrón de solicitud en toda la documentación y se espera que utilice la ruta completa que se muestra en la solicitud de ejemplo al realizar sus propias llamadas a las API de Platform.

Ejemplo de solicitud de API

A continuación se muestra un ejemplo de solicitud de API que muestra el formato que encontrará en la documentación.

Formato de API

El formato de la API muestra la operación (GET) y el punto final que se está utilizando. Las variables se indican entre llaves (en este caso, {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

Solicitud

En esta solicitud de ejemplo, las variables del formato de API reciben valores reales en la ruta de solicitud. Además, todos los encabezados requeridos se muestran como valores de encabezado de ejemplo o variables en las que se debe incluir información confidencial (como tokens de seguridad e ID de acceso).

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}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

La respuesta ilustra lo que esperaría recibir tras una llamada correcta a la API, según la solicitud que se haya enviado. Ocasionalmente, la respuesta se trunca en el espacio, lo que significa que puede ver más información o información adicional a la que se muestra en la muestra.

{
    "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"
        }
    ],
    "_links": {}
}

Mensajes de error

La Guía de solución de problemas de Platform proporciona una lista de errores que puede encontrar al utilizar cualquier servicio de Experience Platform.

Para obtener guías de solución de problemas sobre los servicios de Platform individuales, consulte el directorio de solución de problemas del servicio.

Para obtener más información sobre extremos específicos en las API de plataforma, incluidos los encabezados y los cuerpos de solicitud necesarios, consulte las guías de API de plataforma.

Guías de API de plataforma

Guía de API Descripción
Access Control Guía de API El extremo de la API Access Control puede recuperar las políticas actuales en vigor para un usuario en recursos determinados dentro de un entorno limitado especificado. Todas las demás funcionalidades de control de acceso se proporcionan a través de Adobe Admin Console.
Guía de API de ingesta por lotes La API Data Ingestion de Adobe Experience Platform le permite introducir datos en Platform como archivos por lotes. Los datos introducidos pueden ser los datos de perfil de un archivo plano en un sistema CRM (como un archivo Parquet) o los datos que se ajustan a un esquema conocido en el Registro de esquemas (XDM).
Catalog Service Guía de API La API Catalog Service permite a los desarrolladores administrar metadatos de conjuntos de datos en Adobe Experience Platform. Esto incluye ubicaciones de datos, etapas de procesamiento, errores que se produjeron durante el procesamiento e informes de datos.
Data Access Guía de API La API Data Access permite a los desarrolladores recuperar información sobre conjuntos de datos ingestados dentro de Experience Platform. Esto incluye el acceso y la descarga de archivos de conjuntos de datos, la recuperación de información del encabezado, la lista de lotes con errores y sin éxito, y la descarga de archivos CSV/Parquet de vista previa.
Dataset Service Guía de API La API del servicio de conjunto de datos le permite aplicar y editar etiquetas de uso para conjuntos de datos. Forma parte de las funcionalidades del catálogo de datos de Adobe Experience Platform, pero está separado de la API del servicio de catálogo que administra los metadatos del conjunto de datos.
Flow Service Guía de API
(Fuentes y destinos)
La API Flow Service se utiliza para recopilar y centralizar los datos de diversas fuentes y se utiliza para crear y activar datos en distintos destinos dentro de Adobe Experience Platform. El servicio proporciona una API RESTful desde la que se pueden conectar todas las fuentes admitidas.
Identity Service Guía de API La API Identity Service permite a los desarrolladores administrar la identificación entre dispositivos, canales cruzados y casi en tiempo real de sus clientes mediante gráficos de identidad en Adobe Experience Platform.
Observability Insights Guía de API Observability Insights es una API de RESTful que permite a los desarrolladores exponer métricas clave de observación en Adobe Experience Platform. Estas métricas proporcionan información sobre las estadísticas de uso de Platform, las comprobaciones de estado de los servicios de Platform, las tendencias históricas y los indicadores de rendimiento de varias funcionalidades de Platform.
Policy Service Guía de API
(control de datos)
La API Policy Service le permite crear y administrar etiquetas y políticas de uso de datos para determinar qué acciones de marketing se pueden realizar con datos que contienen ciertas etiquetas de uso de datos. Para aplicar etiquetas a conjuntos de datos y campos, consulte la guía Dataset Service API
Privacy Service Guía de API La API Privacy Service permite a los desarrolladores crear y administrar solicitudes de clientes para acceder a sus datos personales o eliminarlos entre aplicaciones de Experience Cloud, de conformidad con las normas legales de privacidad.
Query Service Guía de API La API Query Service permite a los desarrolladores consultar sus datos de Adobe Experience Platform mediante SQL estándar.
Real-time Customer Profile Guía de API La API de perfil de cliente en tiempo real permite a los desarrolladores explorar y trabajar con datos de perfil, incluida la visualización de perfiles, la creación y actualización de políticas de combinación, la exportación o muestreo de datos de perfil y la eliminación de datos de perfil que ya no son necesarios o que se añadieron por error.
Guía de la API de Sandbox La API de Sandbox permite a los desarrolladores administrar mediante programación entornos aislados de entornos limitados virtuales en Adobe Experience Platform.
Schema Registry Guía de API
(XDM)
La API Schema Registry permite a los desarrolladores administrar mediante programación todos los esquemas y recursos relacionados del Modelo de datos de experiencia (XDM) en Adobe Experience Platform.
Segmentation Service Guía de API La API Segmentation Service permite a los desarrolladores administrar mediante programación las operaciones de segmentación en Adobe Experience Platform. Esto incluye la generación de segmentos y audiencias a partir de los datos del perfil del cliente en tiempo real.
Sensei Machine Learning Guía de API
(Data Science Workspace)
La API Sensei Machine Learning proporciona un mecanismo para que los científicos de datos organicen y administren los servicios de aprendizaje automático (ML) desde la incorporación de algoritmos, la experimentación y la implementación de servicios.

Para obtener más información sobre los extremos específicos y las operaciones disponibles para cada servicio, consulte la documentación de referencia de la API en Adobe I/O.

Pasos siguientes

Este documento introdujo los encabezados requeridos, las guías disponibles y proporcionó un ejemplo de llamada de API. Ahora que tiene los valores de encabezado necesarios para realizar llamadas de API en Adobe Experience Platform, seleccione un punto final de API que desee explorar en la tabla de guías de API de plataforma.

Para obtener respuestas a las preguntas más frecuentes, consulte la Guía de solución de problemas de Platform.

Para configurar un entorno Postman y explorar las colecciones Postman disponibles, consulte la Guía de Platform Postman.

En esta página