Introdução à API Real-Time Customer Profile

Última atualização: 4 de abril de 2025
  • Tópicos:

Criado para:

  • Desenvolvedor

Usando endpoints da API de perfil do cliente em tempo real, você pode executar operações CRUD básicas 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 do 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 do cliente e do comportamento dele ao unir as identidades de vários dispositivos e sistemas.
  • Adobe Experience Platform Segmentation Service: permite criar públicos-alvo a partir de dados de Perfil de Cliente em Tempo Real.
  • Experience Data Model (XDM): a estrutura padronizada pela qual o Experience Platform organiza os dados de experiência do cliente.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Experience 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 fazer chamadas com êxito para pontos de extremidade de API Profile.

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.