Query Service Guía de API

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

Primeros pasos

Esta guía requiere comprender bien los distintos servicios de Adobe Experience Platform involucrados 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 estandarizado mediante el cual se Experience Platform organizan los datos de experiencia del cliente.
  • Sandboxes: Experience Platform proporciona entornos limitados virtuales que dividen una sola Platform instancia en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para utilizar correctamente Query Service con 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 a la API, consulte la sección sobre cómo leer ejemplos de llamadas a la API en la guía de solución de problemas Experience Platform.

Recopilar valores para encabezados necesarios

Para realizar llamadas a las API 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 necesarios en todas las llamadas a la API Platform, como se muestra a continuación:

  • Autorización: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos los recursos de Experience Platform están aislados en entornos limitados virtuales específicos. Todas las solicitudes a las API Platform 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 a la API Query Service. Los siguientes documentos recorren 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 utilizando 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.

En esta página