DocumentaçãoExperience PlatformDocumentação da API do servidor de rede de borda

Autenticação authentication

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor

Visão geral

O Edge Network Server API processa a coleta de dados autenticada e não autenticada, dependendo da origem dos eventos e do domínio de coleta da API.

Para cada solicitação, o Server API verifica a configuração de sequência de dados access type. Usando essa configuração, os clientes podem configurar um fluxo de dados para aceitar dados autenticados ou dados autenticados e não autenticados. Por padrão, ambos os tipos de dados são aceitos.

Para obter detalhes sobre como configurar o tipo de acesso da sequência de dados, consulte a documentação sobre como criar e configurar uma sequência de dados.

Abaixo está um resumo do comportamento, com base na configuração da sequência de dados Access Type e no ponto de extremidade no qual a solicitação é recebida.

Access Type
edge.adobedc.net
server.adobedc.net
misto (padrão)
Não autentica a solicitação
Autentica a solicitação
autenticado
Autentica a solicitação
Autentica a solicitação

As chamadas de API provenientes de um servidor privado em server.adobedc.net devem ser sempre autenticadas.

Pré-requisitos prerequisites

Antes de fazer chamadas para o Server API, verifique se você atende aos seguintes pré-requisitos:

  • Você tem uma conta de organização com acesso ao Adobe Experience Platform.
  • Sua conta Experience Platform tem as funções developer e user habilitadas para o perfil de produto API do Adobe Experience Platform. Contate o administrador do Admin Console para habilitar essas funções para sua conta.
  • Você tem uma Adobe ID. Se você não tiver uma Adobe ID, vá para a Adobe Developer Console e crie uma nova conta.

Coletar credenciais credentials

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

  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id {ORG_ID}

Os recursos no Experience Platform podem ser isolados em sandboxes virtuais específicas. Em solicitações para APIs da Platform, é possível especificar o nome e a ID da sandbox em que a operação ocorrerá. Esses parâmetros são opcionais.

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Para obter mais informações sobre sandboxes no Experience Platform, consulte a documentação de visão geral da sandbox.

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

  • Tipo de conteúdo: application/json

Configurar permissões de gravação do conjunto de dados dataset-write-permissions

Para configurar permissões de gravação do conjunto de dados, vá para o Admin Console, localize o perfil de produto anexado à sua chave de API e defina as seguintes permissões:

  • Na seção Sandboxes, selecione a sandbox da sequência de dados.
  • Na seção Gerenciamento de Dados, selecione a permissão Gerenciar Conjuntos de Dados.

Solução de problemas de erros de autorização troubleshooting-authorization

Código de erro
Mensagem de erro
Descrição
EXEG-0500-401
Token de autorização inválido

Essa mensagem de erro é exibida em qualquer uma das seguintes situações:

  • Valor do cabeçalho authorization ausente.
  • O valor do cabeçalho authorization não inclui o token Bearer necessário.
  • O token de autorização fornecido tem um formato inválido.
  • A sequência de dados requer autenticação, mas a solicitação não tem cabeçalhos obrigatórios.
EXEG-0501-401
Token de autorização de usuário inválido

Essa mensagem de erro é exibida em qualquer uma das seguintes situações:

  • A chamada de API não tem o cabeçalho x-user-token necessário.
  • O token de usuário fornecido tem um formato inválido.
EXEG-0502-401
Token de autorização inválido
Esta mensagem de erro é exibida quando o token de autorização fornecido tem um formato válido (JWT), mas sua assinatura é inválida. Verifique o tutorial de autenticação para saber como obter um token JWT válido.
EXEG-0503-401
Token de autorização inválido
Esta mensagem de erro é exibida quando o token de autorização fornecido expira. Percorra o tutorial de autenticação para gerar um novo token.
EXEG-0504-401
O contexto do produto obrigatório está ausente

Essa mensagem de erro é exibida em qualquer uma das seguintes situações:

  • A conta de desenvolvedor não tem acesso ao contexto de produto do Adobe Experience Platform.
  • A conta da empresa ainda não está qualificada para a Adobe Experience Platform.
EXEG-0505-401
O escopo do token de autorização necessário está ausente
Esse erro se aplica somente à autenticação da conta de serviço do. A mensagem de erro é exibida quando o token de autorização de serviço incluído na chamada pertence a uma conta de serviço que não tem acesso ao escopo IMS acp.foundation.
EXEG-0506-401
Sandbox não acessível para gravação
Esta mensagem de erro é exibida quando a conta do desenvolvedor não tem acesso WRITE à sandbox do Experience Platform em que o fluxo de dados é definido.
recommendation-more-help
f36c2cef-1417-40aa-a11d-5d0abaee121b