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 almacén de metadatos o "catálogo", donde puede encontrar información sobre sus datos dentro de Experience Platform, sin necesidad de acceder a los datos en sí. Consulte la Catalog información general para obtener más información.

Esta guía para desarrolladores proporciona los pasos para ayudarle a empezar a usar el Catalog API. A continuación, la guía proporciona ejemplos de llamadas de API 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 las distintas Experience Platform servicios relacionados con la creación y administración de estos recursos:

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

Las secciones siguientes proporcionan información adicional que debe conocer o tener disponible para realizar llamadas correctamente al Catalog 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. 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 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. Todas las solicitudes a Platform Las API requieren un encabezado que especifique el nombre del simulador para pruebas en el que se realizará la operación:

  • 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

Prácticas recomendadas para Catalog Llamadas de API

Al realizar solicitudes de GET a la variable Catalog , se recomienda incluir parámetros de consulta en las solicitudes para devolver solo los objetos y las 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 la solicitud o utilizando parámetros de consulta como properties y limit para filtrar respuestas. Los filtros se pueden pasar como encabezados y como parámetros de consulta, con prioridad para los que se pasan como parámetros de consulta. Consulte el documento en filtrado de datos del catálogo para obtener más información.

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

Pasos siguientes

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

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

Para un flujo de trabajo paso a paso que muestre cómo se usa la variable Catalog La API está relacionada con la ingesta de datos, consulte el tutorial sobre creación de un conjunto de datos.

En esta página