Guía de la API de Catalog Service
- Temas:
- Catálogo
Creado para:
- Desarrollador
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 acerca de sus datos en Experience Platform, sin necesidad de tener acceso 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 utilizar la API de Catalog. 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 servicios de Experience Platform implicados en la creación y administración de estos recursos:
- Experience Data Model (XDM): El marco estandarizado mediante el cual Experience Platform organiza los datos de experiencia del cliente.
- Ingesta por lotes: Cómo Experience Platform ingiere y almacena datos de archivos de datos, como CSV y Parquet.
- Ingesta de transmisión: Cómo Experience Platform ingiere y almacena datos de dispositivos del lado del cliente y del lado del servidor en tiempo real.
Las secciones siguientes proporcionan información adicional que necesitará saber o tener disponible para realizar llamadas correctamente a la API Catalog Service.
Lectura de llamadas de API de muestra
Esta guía proporciona ejemplos de llamadas de 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 la 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 las llamadas de API de ejemplo en la guía de solución de problemas de Experience Platform.
Recopilación de valores para los encabezados obligatorios
Para poder realizar llamadas a las API de Experience Platform, 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 obligatorios en todas las llamadas de API de Experience Platform, 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 aislados en zonas protegidas virtuales específicas. Todas las solicitudes a las API de Experience 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}
NOTETodas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado adicional:
- Content-Type: application/json
Prácticas recomendadas para llamadas a la API Catalog
Al realizar solicitudes de GET a la API Catalog, se recomienda incluir parámetros de consulta en las solicitudes para devolver únicamente 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 solicitud o usar 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 cargar gravemente la API, se han implementado límites globales en Catalog consultas para admitir aún más las prácticas recomendadas.
Pasos siguientes
Este documento cubría los conocimientos previos necesarios para realizar llamadas a la API de Catalog. Ahora puede continuar con las llamadas de muestra 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 el extremo /dataSets, pero los principios se pueden aplicar a otros extremos dentro de Catalog (como /batches). 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 obtener un flujo de trabajo paso a paso que muestra cómo la API Catalog está implicada en la ingesta de datos, consulte el tutorial sobre creación de un conjunto de datos.