Introdução à Real-time Customer Profile API

Usando a Real-time Customer Profile API, você pode executar operações CRUD básicas em relação aos recursos 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 Profile dados. Antes de começar a trabalhar com a Real-time Customer Profile API, consulte a documentação dos seguintes serviços:

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

Lendo chamadas de exemplo da API

A documentação da Real-time Customer Profile API 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 amostra retornado em respostas de API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de amostra, consulte a seção sobre como ler chamadas de API de exemplo no guia de Experience Platform solução de problemas.

Cabeçalhos obrigatórios

A documentação da API também exige que você tenha concluído o tutorial de autenticação para fazer chamadas com êxito para Platform pontos de extremidade. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em chamadas de Experience Platform API, como 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 caixas de proteção virtuais específicas. As solicitações para Platform APIs exigem um cabeçalho que especifique o nome da caixa de proteção em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}

Para obter mais informações sobre caixas de proteção em Platform, consulte a documentação de visão geral dacaixa de proteção.

Todas as solicitações com uma carga no corpo da solicitação (como chamadas de POST, PUT e PATCH) devem incluir um Content-Type cabeçalho. Valores aceitos específicos para cada chamada são fornecidos nos parâmetros da chamada.

Próximas etapas

Para começar a fazer chamadas usando a Real-time Customer Profile API, selecione um dos guias de ponto de extremidade disponíveis.

Nesta página