Introdução à API Real-time Customer Profile

Usando os pontos de extremidade da API de perfil do cliente em tempo real, é possível executar operações básicas de CRUD em relação aos dados do perfil, como configurar atributos calculados, acessar entidades, exportar dados do perfil e excluir conjuntos de dados ou lotes desnecessários.

O uso do guia do desenvolvedor requer uma compreensão funcional dos vários serviços da Adobe Experience Platform envolvidos no trabalho com dados Profile. Antes de começar a trabalhar com a API Real-time Customer Profile, reveja a documentação dos seguintes serviços:

  • Real-time Customer Profile: Fornece um perfil de cliente unificado em tempo real com base em dados agregados de várias fontes.
  • Adobe Experience Platform Identity Service: Obtenha uma melhor visão de seu cliente e de seu comportamento ao unir identidades em dispositivos e sistemas.
  • Adobe Experience Platform Segmentation Service: Permite criar segmentos de público-alvo a partir de dados do Perfil do cliente em tempo real.
  • Experience Data Model (XDM): A estrutura padronizada pela qual a Platform organiza os dados de experiência do cliente.
  • Sandboxes: Experience Platform O fornece sandboxes virtuais que particionam uma única Platform instância 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 fazer chamadas com êxito para os endpoints da API Profile.

Lendo exemplos de chamadas de API

A documentação da API Real-time Customer Profile fornece exemplos de chamadas de API para demonstrar como formatar corretamente as solicitações. 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 chamadas de API de exemplo no Experience Platform guia de solução de problemas.

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 Platform. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em chamadas de API Experience Platform, conforme mostrado abaixo:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos os recursos em Experience Platform são isolados para sandboxes virtuais específicas. As solicitações para Platform APIs exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}

Para obter mais informações sobre sandboxes em 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 de 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 guias de ponto de extremidade disponíveis.

Nesta página