Guía de la API de Query Service

Última actualización: 2023-03-13
  • Temas:
  • Queries
    Ver más sobre este tema
  • Creado para:
  • Developer
    User
    Admin
    Leader

Esta guía para desarrolladores proporciona 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 relacionados 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 Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para utilizar correctamente Query Service uso de la API.

Leer llamadas de API de muestra

Esta guía proporciona ejemplos de llamadas 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 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 llamadas de API de ejemplo en el Experience Platform guía de solución de problemas.

Recopilar valores para los encabezados obligatorios

Para realizar llamadas a Experience Platform API, 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 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 zonas protegidas virtuales específicas. Todas las solicitudes a Platform Las API requieren un encabezado que especifique el nombre de la zona protegida en la 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 sobre zonas protegidas.

Llamadas de API de muestra

Ahora que comprende qué encabezados utilizar, está listo para empezar a realizar llamadas al Query Service API. Los siguientes documentos explican las distintas llamadas a la API que puede realizar mediante la variable 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 hacer llamadas con el 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 de SQL.

En esta página