Os guias da API do cliente exigem uma compreensão funcional dos vários serviços da plataforma envolvidos no uso da API do cliente. Antes de começar, reveja os seguintes documentos:
Se não precisar baixar pontuações brutas, ignore esta etapa e prossiga para a guia de configuração.
O download das pontuações do Customer AI é feito por meio de uma combinação de chamadas de API. Para fazer chamadas para APIs da plataforma, primeiro conclua 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 do Experience Platform, conforme mostrado abaixo:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Todos os recursos no Experience Platform são isolados para sandboxes virtuais específicas. Todas as solicitações para APIs da plataforma exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:
{SANDBOX_NAME}
Para obter mais informações sobre sandboxes na Platform, consulte o documentação de visão geral da sandbox.
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 na documentação para chamadas de API de exemplo, consulte a seção sobre como ler exemplos de chamadas de API no guia de solução de problemas do Experience Platform.
Ao usar o controle de acesso, a variável Exibir AI do cliente e Gerenciar o Customer AI concede acesso a diferentes funcionalidades da API do cliente. O Gerenciar o Customer AI permissão permite criar,atualizar, excluir, habilitar ou disable uma instância ao Exibir AI do cliente permite que você leia ou visualize. O criar, atualizar e excluir ações são registradas por logs de auditoria.
Consulte a documentação para saber mais atribuição de permissões para controle de acesso ou como usar logs de auditoria para monitorar o acesso e a atividade.
Depois de concluir as etapas descritas no documento acima, visite o Entrada e saída documentação. Este documento fornece uma breve visão geral de quais tipos de dados são usados e produzidos no Customer AI.