Query Service Manual 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 no uso do Query Service.
- Query Service: Fornece a capacidade de consultar conjuntos de dados e capturar as consultas resultantes como novos conjuntos de dados em Experience Platform.
- Experience Data Model (XDM) System: a estrutura padronizada pela qual o Experience Platform organiza os dados de experiência do cliente.
- Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Platform 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 com êxito o Query Service usando a API.
Leitura de chamadas de API de amostra
Este manual fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. 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 guia de solução de problemas Experience Platform.
Coletar valores para cabeçalhos necessários
Para fazer chamadas para APIs do Experience Platform, primeiro complete o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API da Platform, conforme mostrado abaixo:
- Autorização:
Bearer {ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id
{ORG_ID}
Todos os recursos em Experience Platform estão isolados em sandboxes virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:
- x-sandbox-name:
{SANDBOX_NAME}
Exemplos de chamadas de API
Agora que você entende quais cabeçalhos usar, você está pronto para começar a fazer chamadas para a API Query Service. Os documentos a seguir abordam as várias chamadas de API que podem ser feitas usando a API Query Service. Cada chamada de exemplo inclui o formato geral da API, 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, poderá criar suas próprias consultas não interativas. Para obter mais informações sobre como criar consultas, leia o Guia de Referência SQL.