Introducción a las API de Adobe Experience Platform

Última actualización: 2023-11-04
  • Creado para:
  • Developer
    User
    Admin
    Leader

Adobe Experience Platform se desarrolla bajo la filosofía "API First". Con las API de Platform, puede realizar mediante programación operaciones básicas de CRUD (crear, leer, actualizar, eliminar) con datos, como configurar atributos calculados, acceder a datos o entidades, exportar datos, eliminar datos o lotes innecesarios, etc.

Todas 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 empezar a utilizar las API de Platform.

Autenticación y encabezados

Para realizar llamadas correctamente a los extremos de Platform, debe completar el tutorial de autenticación. Al completar el tutorial de autenticación, se proporcionan los valores de cada uno de los encabezados necesarios en las llamadas de API de Experience Platform, como se muestra a continuación:

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

Encabezado de zona protegida

Todos los recursos de Experience Platform están aislados para zonas protegidas virtuales específicas. Las solicitudes a las API de Platform requieren un encabezado que especifique el nombre de la zona protegida en la que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}

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

Encabezado de tipo de contenido

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

Fundamentos de API de Experience Platform

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

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

Colecciones de 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 de CRUD y mucho más. La mayoría de los servicios de API de Platform tienen colecciones de 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.

Lectura de llamadas de API de muestra

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

La documentación de Experience Platform muestra las llamadas de API de ejemplo de dos formas diferentes. En primer lugar, la llamada de se presenta en su Formato de API, una representación de plantilla que muestra solo 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}.

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 prefijarse a todos los extremos. Por ejemplo, los mencionados /global/classes el punto final se convierte en https://platform.adobe.io/data/foundation/schemaregistry/global/classes. Verá el formato de la 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 mediante llaves (en este caso, {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

Solicitud

En esta solicitud de ejemplo, las variables del formato API reciben valores reales en la ruta de solicitud. Además, todos los encabezados requeridos se muestran como valores de encabezado de muestra o como variables donde 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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

La respuesta ilustra lo que esperaría recibir después de una llamada correcta a la API, según la solicitud enviada. En ocasiones, la respuesta se trunca en cuanto al espacio, lo que significa que puede ver más información o información adicional que la mostrada en el ejemplo.

{
    "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

El Guía de solución de problemas de Platform proporciona una lista de errores que pueden producirse al utilizar cualquier servicio de Experience Platform.

Para obtener guías de solución de problemas sobre servicios de Platform individuales, consulte la directorio de solución de problemas de servicios.

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

Guías de API de Platform

Guía de la API de Descripción
Guía de la API de Access Control El Access Control El extremo de API puede recuperar las políticas actuales en vigor para un usuario en recursos determinados dentro de una zona protegida especificada. Todas las demás capacidades de control de acceso se proporcionan a través de la Adobe Admin Console.
Guía de API de ingesta por lotes El Adobe Experience Platform Data Ingestion La API de le permite introducir datos en Platform como archivos por lotes. Los datos que se están ingiriendo pueden ser los datos de perfil de un archivo plano de un sistema CRM (como un archivo de Parquet) o los datos que se ajustan a un esquema conocido en el Registro de esquemas (XDM).
Guía de la API de Catalog Service El Catalog Service La API 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.
Guía de la API de Data Access El Data Access La API permite a los desarrolladores recuperar información sobre conjuntos de datos ingeridos dentro de Experience Platform. Esto incluye el acceso y la descarga de archivos de conjuntos de datos, la recuperación de información de encabezado, la lista de lotes fallidos y exitosos y la descarga de archivos de previsualización CSV / Parquet.
Guía de la API de Dataset Service La API del servicio de conjuntos de datos permite aplicar y editar etiquetas de uso para conjuntos de datos. Forma parte de las funciones del catálogo de datos de Adobe Experience Platform, pero es independiente de la API del servicio de catálogo que administra los metadatos del conjunto de datos.
Guía de la API de Edge Network Server El Edge Network Server API se puede utilizar para una variedad de casos de uso de recopilación de datos, personalización, publicidad y marketing. El Server API se puede utilizar en servidores de, IoT dispositivos, decodificadores y una variedad de otros dispositivos.
Guía de la API de Identity Service El Identity Service La API permite a los desarrolladores administrar la identificación de sus clientes en varios dispositivos, canales cruzados y casi en tiempo real mediante gráficos de identidad en Adobe Experience Platform.
Guía de la API de Observability Insights Observability Insights es una API de RESTful que permite a los desarrolladores exponer métricas clave de observabilidad en Adobe Experience Platform. Estas métricas proporcionan perspectivas 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
(Gobernanza de datos)
El Policy Service La API permite crear y administrar etiquetas y políticas de uso de datos para determinar qué acciones de marketing se pueden realizar con datos que contengan determinadas etiquetas de uso de datos. Para aplicar etiquetas a conjuntos de datos y campos, consulte la Dataset Service API guía
Guía de la API de Privacy Service El Privacy Service La API permite a los desarrolladores crear y administrar solicitudes de clientes para acceder a sus datos personales o eliminarlos en aplicaciones de Experience Cloud, de acuerdo con las regulaciones legales de privacidad.
Guía de la API de Query Service El Query Service La API permite a los desarrolladores consultar sus datos de Adobe Experience Platform utilizando SQL estándar.
Guía de la API de Real-Time Customer Profile La API de Perfil del 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 el 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 API de zona protegida La API de espacio aislado permite a los desarrolladores administrar mediante programación entornos de espacio aislado virtuales en Adobe Experience Platform.
Schema Registry Guía de API
(XDM)
El Schema Registry La API permite a los desarrolladores administrar mediante programación todos los esquemas y los recursos del Modelo de datos de experiencia (XDM) relacionados dentro de Adobe Experience Platform.
Guía de la API de Segmentation Service El Segmentation Service La API 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)
El Sensei Machine Learning La API proporciona un mecanismo para que los científicos de datos organicen y administren los servicios de aprendizaje automático (ML) desde la incorporación del algoritmo, 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 del API en el Adobe I/O.

Pasos siguientes

Este documento introdujo los encabezados necesarios, 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 Tabla de guías de API de Platform.

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

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

En esta página