Guía de la API de Catalog Service

Catalog Service es el sistema de registro para la ubicación y el linaje de datos dentro de Adobe Experience Platform. Catalog actúa como un almacén de metadatos o catálogo en el que puede encontrar información sobre sus datos dentro de Experience Platform, sin necesidad de acceder a los propios datos. Consulte la Catalog descripción general para obtener más información.

Esta guía para desarrolladores proporciona pasos para ayudarle a empezar a utilizar Catalog API. A continuación, la guía proporciona llamadas de API de ejemplo para realizar operaciones clave mediante Catalog.

Requisitos previos

Catalog rastrea metadatos para varios tipos de recursos y operaciones dentro de Experience Platform. Esta guía para desarrolladores requiere una comprensión práctica de los distintos Experience Platform servicios implicados en la creación y gestión de estos recursos:

Experience Data Model (XDM): El marco estandarizado mediante el cual Platform organiza los datos de experiencia del cliente.
Ingesta por lotes: Cómo Experience Platform incorpora y almacena datos de archivos de datos, como CSV y Parquet.
Ingesta por streaming: Cómo Experience Platform incorpora y almacena datos de dispositivos del lado del cliente y del servidor en tiempo real.

Las secciones siguientes proporcionan información adicional que deberá conocer o tener disponible para poder realizar llamadas correctamente a Catalog Service API.

Leer llamadas de API de muestra

Esta guía proporciona ejemplos de llamadas API para mostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados obligatorios y cargas de solicitud con el formato correcto. 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 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 los encabezados obligatorios

Para realizar llamadas a Platform API, 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 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 zonas protegidas virtuales específicas. Todas las solicitudes a Platform Las API requieren un encabezado que especifique el nombre de la zona protegida en la que se realizará la operación:

x-sandbox-name: {SANDBOX_NAME}

NOTA

Para obtener más información sobre las zonas protegidas en Platform, consulte la documentación general de zona protegida.

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

Content-Type: application/json

Prácticas recomendadas para Catalog Llamadas de API

Al realizar solicitudes de GET a Catalog API, la práctica recomendada es incluir parámetros de consulta en las solicitudes para devolver solo los objetos y propiedades que necesite. Las solicitudes sin filtrar pueden hacer que las cargas de respuesta superen los 3 GB de tamaño, lo que puede ralentizar el rendimiento general.

Puede ver objetos específicos incluyendo su ID en la ruta de solicitud o utilizando parámetros de consulta como properties y limit para filtrar las respuestas. Los filtros se pueden pasar como encabezados y como parámetros de consulta, y los que se pasan como parámetros de consulta tienen prioridad. Consulte el documento sobre filtrado de datos de catálogo para obtener más información.

Dado que algunas consultas pueden suponer una carga pesada en la API, se han implementado límites globales en Catalog consultas para seguir ofreciendo soporte a las prácticas recomendadas.

Pasos siguientes

Este documento abarcaba los conocimientos previos necesarios para realizar llamadas a la Catalog API. Ahora puede continuar con las llamadas de ejemplo proporcionadas en esta guía para desarrolladores y seguir junto con sus instrucciones.

La mayoría de los ejemplos de esta guía utilizan el /dataSets extremo, pero los principios se pueden aplicar a otros extremos dentro de Catalog (como /batches y /accounts). Consulte la Referencia de API del servicio de catálogo para obtener una lista completa de todas las llamadas y operaciones disponibles para cada extremo.

Para obtener un flujo de trabajo paso a paso que muestre cómo se utilizan las etiquetas Catalog La API participa en la ingesta de datos. Consulte el tutorial sobre creación de un conjunto de datos.