Query Service Guia de API

Este guia do desenvolvedor fornece etapas para executar várias operações na API do Adobe Experience Platform Query Service.

Introdução

Este guia requer uma compreensão de trabalho dos vários serviços da Adobe Experience Platform envolvidos com o uso de Query Service.

  • Query Service: Fornece a capacidade de query de conjuntos de dados e captura os query resultantes como novos conjuntos de dados em Experience Platform.
  • Experience Data Model (XDM) System: A estrutura padronizada pela qual Experience Platform organiza os dados de experiência do cliente.
  • Sandboxes: Experience Platform fornece caixas de proteção virtuais que particionam uma única Platform instância em ambientes virtuais separados para ajudar a desenvolver e desenvolver aplicativos de experiência digital.

As seções a seguir fornecem informações adicionais que você precisará saber para usar Query Service com êxito usando a API.

Lendo chamadas de exemplo da API

Este guia fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de amostra retornado em respostas de API também é fornecido. Para obter informações sobre as convenções usadas nesta documentação para chamadas de API de amostra, consulte a seção sobre como ler chamadas de API de exemplo no guia de solução de problemas Experience Platform.

Reunir valores para cabeçalhos necessários

Para fazer chamadas para Experience Platform APIs, você deve primeiro concluir o tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API Platform, como mostrado abaixo:

  • Autorização: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos os recursos em Experience Platform são isolados para caixas de proteção virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da caixa de proteção na qual a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
OBSERVAÇÃO

Para obter mais informações sobre como trabalhar com caixas de proteção em Experience Platform, consulte a documentação de visão geral das caixas de proteção.

Chamadas de API de exemplo

Agora que você entende quais cabeçalhos devem ser usados, você está pronto para começar a fazer chamadas para a API Query Service. Os documentos a seguir percorrem várias chamadas de API que podem ser feitas usando a API Query Service. Cada chamada de exemplo inclui o formato de API geral, uma solicitação de amostra mostrando os cabeçalhos necessários e uma resposta de amostra.

Próximas etapas

Agora que você aprendeu a fazer chamadas usando a API Query Service, é possível criar seus próprios query não interativos. Para obter mais informações sobre como criar query, leia o guia de referência SQL.

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now