Identity Service Guia da API

O Adobe Experience Platform Identity Service gerencia a identificação entre dispositivos, entre canais e quase em tempo real dos clientes no que é conhecido como um gráfico de identidade no Adobe Experience Platform.

Introdução

Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

  • Identity Service: Resolve o desafio fundamental colocado pela fragmentação dos dados de perfil do cliente. Ele faz isso através da conexão de identidades entre dispositivos e sistemas, onde os clientes interagem com a sua marca.
  • Real-time Customer Profile: Fornece um perfil de consumidor unificado em tempo real com base em dados agregados de várias fontes.
  • Experience Data Model (XDM): A estrutura padronizada pela qual Platform organiza os dados de experiência do cliente.

As seções a seguir fornecem informações adicionais que você precisará saber ou ter em mãos para fazer chamadas com êxito para a API Identity Service.

Lendo exemplos de chamadas de API

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 chamadas de API de exemplo no Experience Platform guia de solução de problemas.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para Platform APIs, primeiro complete 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 Experience Platform, conforme mostrado abaixo:

  • Autorização: Portador {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. Todas 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}
OBSERVAÇÃO

Para obter mais informações sobre sandboxes em Platform, consulte a documentação de visão geral da sandbox.

Todas as solicitações que contêm uma carga útil (POST, PUT, PATCH) exigem um cabeçalho adicional:

  • Tipo de conteúdo: application/json

Roteamento baseado na região

A API Identity Service emprega endpoints específicos da região que exigem a inclusão de um {REGION} como parte do caminho da solicitação. Durante o provisionamento da organização IMS, uma região é determinada e armazenada no perfil da Organização IMS. Usar a região correta com cada endpoint garante que todas as solicitações feitas usando a API Identity Service sejam roteadas para a região apropriada.

Há duas regiões atualmente compatíveis com Identity Service APIs: VA7 e NLD2.

A tabela abaixo mostra exemplos de caminhos usando regiões:

Serviço de Região: VA7 Região: NLD2
Identity Service API https://platform-va7.adobe.io/data/core/identity/ https://platform-nld2.adobe.io/data/core/identity/
Identity Namespace API https://platform-va7.adobe.io/data/core/namespace/ https://platform-nld2.adobe.io/data/core/namespace
OBSERVAÇÃO

As solicitações feitas sem especificar uma região podem resultar no roteamento de chamadas para a região incorreta ou causar falha inesperada de chamadas.

Se você não conseguir localizar a região no seu perfil da Organização IMS, entre em contato com o administrador do sistema para obter suporte.

Uso da API Identity Service

Os parâmetros de identidade utilizados nestes serviços podem ser expressos de uma das duas formas seguintes: composto ou XID.

Identidades compostas são construções que incluem o valor da ID e o namespace. Ao usar identidades compostas, o namespace pode ser fornecido pelo nome (namespace.code) ou ID (namespace.id).

Quando uma identidade é persistente, Identity Service gera e atribui uma ID a essa identidade, chamada de ID nativa ou XID. Todas as variações de APIs de Cluster e Mapeamento são compatíveis com identidades compostas e XID em suas solicitações e resposta. Um dos parâmetros é necessário - xid ou combinação de [ns ou nsid] e id para usar essas APIs.

Para limitar a carga nas respostas, as APIs adaptam suas respostas ao tipo de construção de identidade usada. Ou seja, se você passar o XID, suas respostas terão XIDs, se você passar identidades compostas, a resposta seguirá a estrutura usada na solicitação.

Os exemplos neste documento não cobrem a funcionalidade completa da API Identity Service. Para obter a API completa, consulte a Referência da API Swagger.

OBSERVAÇÃO

Todas as identidades retornadas estarão no formulário XID nativo quando o XID nativo for usado na solicitação. É recomendável usar o formulário ID/namespace. Para obter mais informações, consulte a seção sobre obter o XID para uma identidade.

Próximas etapas

Agora que você coletou as credenciais necessárias, pode continuar a ler o resto do guia do desenvolvedor. Cada seção fornece informações importantes sobre seus endpoints e demonstra chamadas de API de exemplo para executar operações CRUD. Cada chamada inclui o formato da API geral, uma solicitação de amostra que mostra os cabeçalhos necessários e as cargas corretamente formatadas e uma resposta de amostra para uma chamada bem-sucedida.

Nesta página

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now