Guía de la API de Query Service
Esta guía para desarrolladores proporciona pasos para realizar diversas operaciones en la API de Adobe Experience Platform Query Service.
Introducción
Esta guía requiere una comprensión práctica de los distintos servicios de Adobe Experience Platform involucrados con el uso de Query Service.
- Query Service: proporciona la capacidad de consultar conjuntos de datos y capturar las consultas resultantes como nuevos conjuntos de datos en Experience Platform.
- Experience Data Model (XDM) System: El marco estandarizado mediante el cual Experience Platform organiza los datos de experiencia del cliente.
- Sandboxes: Experience Platform proporciona zonas protegidas virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.
Las secciones siguientes proporcionan información adicional que necesitará conocer para usar correctamente Query Service mediante la API.
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 esta documentación para 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 Platform, como se muestra a continuación:
- Autorización:
Bearer {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 Platform requieren un encabezado que especifica el nombre de la zona protegida en la que se realizará la operación:
- x-sandbox-name:
{SANDBOX_NAME}
Llamadas de API de muestra
Ahora que comprende qué encabezados utilizar, está listo para empezar a realizar llamadas a la API Query Service. Los siguientes documentos explican las distintas llamadas de API que puede realizar mediante la API Query Service. Cada llamada de ejemplo incluye el formato de API general, una solicitud de ejemplo que muestra los encabezados necesarios y una respuesta de ejemplo.
Pasos siguientes
Ahora que ha aprendido a hacer llamadas usando la API Query Service, puede crear sus propias consultas no interactivas. Para obtener más información sobre cómo crear consultas, lea la guía de referencia de SQL.