Query Service Guia da API

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

Introdução

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

  • Query Service: Fornece a capacidade de consultar conjuntos de dados e capturar as consultas resultantes como novos conjuntos de dados no 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 O fornece sandboxes virtuais que particionam uma única Platform instância em ambientes virtuais separados para ajudar a 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 exemplos de chamadas de API

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

Coletar valores para cabeçalhos necessários

Para fazer chamadas para Experience Platform APIs, primeiro complete 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, conforme 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 sandboxes virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:

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

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

Exemplos de chamadas de API

Agora que você sabe quais cabeçalhos usar, está pronto para começar a fazer chamadas para a API Query Service. Os seguintes documentos percorrem as várias chamadas de API que você pode fazer usando a API Query Service. Cada chamada de exemplo inclui o formato da API geral, uma solicitação de amostra que mostra 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 suas próprias consultas não interativas. Para obter mais informações sobre como criar consultas, leia o Guia de Referência SQL.

Nesta página