Show Menu
TÓPICOS×

Guia do desenvolvedor do Query Service

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

Introdução

Este guia exige uma compreensão funcional dos vários serviços da plataforma Adobe Experience envolvidos com o uso do Serviço de Query.
  • Serviço de Query: Fornece a capacidade de query de conjuntos de dados e captura os query resultantes como novos conjuntos de dados na plataforma Experience.
  • Sistema do Experience Data Model (XDM): A estrutura padronizada pela qual a plataforma Experience organiza os dados da experiência do cliente.
  • Caixas de proteção : A plataforma Experience fornece caixas de proteção virtuais que particionam uma única instância da Plataforma 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 o Serviço de Query 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 da plataforma Experience.

Reunir valores para cabeçalhos necessários

Para fazer chamadas para APIs da plataforma Experience, 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 à API de plataforma, como mostrado abaixo:
  • Autorização: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Todos os recursos da plataforma Experience são isolados para caixas de proteção virtuais específicas. Todas as solicitações para APIs de plataforma exigem um cabeçalho que especifique o nome da caixa de proteção na qual a operação ocorrerá:
  • x-sandbox-name: {SANDBOX_NAME}
Para obter mais informações sobre como trabalhar com caixas de proteção na 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 de serviço do Query. Os documentos a seguir percorrem várias chamadas de API que podem ser feitas usando a API de serviço de Query. 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 de serviço de Query, é 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.