Identity Service Manual da API
Adobe Experience Platform Identity Service O gerencia a identificação entre dispositivos, canais e quase em tempo real dos clientes no que é conhecido como um gráfico de identidade na Adobe Experience Platform.
Introdução
Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:
- Identity Service: soluciona o desafio fundamental imposto pela fragmentação dos dados de perfil do cliente. Ele faz isso unindo identidades em dispositivos e sistemas nos quais os clientes interagem com 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): o quadro normalizado pelo 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 o Identity Service API.
Leitura de chamadas de API de amostra
Este manual fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. 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 Experience Platform guia de solução de problemas.
Coletar valores para cabeçalhos necessários
Para fazer chamadas para Platform APIs, primeiro conclua o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API da Experience Platform, conforme mostrado abaixo:
- Autorização: Portador
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Todos os recursos em Experience Platform são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:
- x-sandbox-name:
{SANDBOX_NAME}
Todas as solicitações que contêm um conteúdo (POST, PUT, PATCH) exigem um cabeçalho adicional:
- Tipo de conteúdo: application/json
Roteamento baseado em região
A variável Identity Service A API 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, uma região é determinada e armazenada no perfil da organização. Usar a região correta com cada endpoint garante que todas as solicitações feitas usando o Identity Service As APIs são roteadas para a região apropriada.
Atualmente, há duas regiões compatíveis com o Identity Service APIs: VA7 e NLD2.
A tabela abaixo mostra caminhos de exemplo usando regiões:
Se não conseguir localizar a região no perfil da organização, entre em contato com o administrador do sistema para obter suporte.
Usar o Identity Service API
Os parâmetros de identidade usados nesses serviços podem ser expressos de uma das duas formas: composta ou XID.
Identidades compostas são construções que incluem o valor de ID e o namespace. Ao usar identidades compostas, o namespace pode ser fornecido por qualquer nome (namespace.code) ou ID (namespace.id).
Quando uma identidade é persistente, Identity Service O gera e atribui uma ID a essa identidade, chamada de ID nativa ou XID. Todas as variações de APIs de cluster e mapeamento oferecem suporte a identidades compostas e XID em suas solicitações e respostas. Um dos parâmetros é obrigatório - xid ou combinação de [ns ou nsid] e id para usar essas APIs.
Para limitar o conteúdo nas respostas, as APIs adaptam suas respostas ao tipo de construção de identidade usada. Ou seja, se você passar 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 abrangem a funcionalidade completa do Identity Service API. Para obter a API completa, consulte a Referência da API do Swagger.
Próximas etapas
Agora que você reuniu as credenciais necessárias, pode continuar lendo o restante do guia do desenvolvedor. Cada seção fornece informações importantes sobre seus endpoints e demonstra exemplos de chamadas de API para executar operações CRUD. Cada chamada inclui o formato da API geral, uma solicitação de amostra mostrando os cabeçalhos necessários e cargas úteis formatadas corretamente e uma resposta de amostra para uma chamada bem-sucedida.