Guía de la API de Query Service

Esta guía para desarrolladores proporciona los pasos para realizar varias operaciones en Adobe Experience Platform Query Service API.

Primeros pasos

Esta guía requiere una comprensión práctica de los distintos servicios de Adobe Experience Platform implicados en 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 normalizado por el cual Experience Platform organiza los datos de experiencia del cliente.
  • Sandboxes: Experience Platform proporciona entornos limitados virtuales que dividen un solo Platform en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que debe conocer para utilizar correctamente Query Service usando la 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 esta documentación para ver ejemplos de llamadas de API, 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 Experience 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 Platform Llamadas de API, 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 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 cómo trabajar con entornos limitados en Experience Platform, consulte la documentación general de entornos limitados.

Ejemplo de llamadas a API

Ahora que comprende qué encabezados utilizar, está listo para empezar a realizar llamadas al Query Service API. Los siguientes documentos recorren las distintas llamadas de API que puede realizar mediante el Query Service API. 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 realizar llamadas utilizando la variable Query Service API, puede crear sus propias consultas no interactivas. Para obtener más información sobre cómo crear consultas, lea la Guía de referencia SQL.

En esta página