Query Service Manual da API

Última atualização em 2024-02-28
  • Tópicos
  • Queries
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer

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

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 no Experience Platform.
  • Experience Data Model (XDM) System: o quadro normalizado pelo qual Experience Platform organiza os dados de experiência do cliente.
  • Sandboxes: Experience Platform O fornece sandboxes virtuais que particionam uma única 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 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 Experience Platform guia de solução de problemas.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para Experience Platform APIs, primeiro conclua 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 são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique 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 no Experience Platform, consulte o documentação de visão geral das sandboxes.

Exemplos de chamadas de API

Agora que você entende quais cabeçalhos usar, você está pronto para começar a fazer chamadas para o Query Service API. Os documentos a seguir abordam as várias chamadas de API que podem ser feitas usando o Query Service API. 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 o Query Service , você 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.

Nesta página