Leitura de chamadas de API de amostra
A documentação da API Real-Time Customer Profile fornece exemplos de chamadas de API para demonstrar como formatar solicitações corretamente. 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 na 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.
Cabeçalhos obrigatórios
A documentação da API também requer que você tenha concluído o tutorial de autenticação para fazer chamadas com êxito para pontos de extremidade Experience Platform. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários nas chamadas de API Experience Platform, conforme mostrado abaixo:
Authorization: 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. As solicitações para Experience Platform APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:
x-sandbox-name: {SANDBOX_NAME}
Para obter mais informações sobre sandboxes em Experience Platform, consulte a documentação de visão geral da sandbox.
Todas as solicitações com uma carga no corpo da solicitação (como chamadas POST, PUT e PATCH) devem incluir um cabeçalho Content-Type
. Os valores aceitos específicos para cada chamada são fornecidos nos parâmetros de chamada.
Próximas etapas
Para começar a fazer chamadas usando a API Real-Time Customer Profile, selecione um dos manuais de ponto de extremidade disponíveis.