No encaminhamento de eventos, um segredo é um recurso que representa uma credencial de autenticação para outro sistema, permitindo a troca segura de dados. Segredos só podem ser criados nas propriedades de encaminhamento de eventos.
No momento, há três tipos secretos compatíveis:
Tipo de segredo | Descrição |
---|---|
Token | Uma única string de caracteres representando um valor de token de autenticação conhecido e compreendido por ambos os sistemas. |
HTTP | Contém dois atributos de string para um nome de usuário e senha, respectivamente. |
OAuth2 | Contém vários atributos para suportar a variável OAuth2 especificação de autenticação. O sistema solicita as informações necessárias e, em seguida, lida com a renovação desses tokens para você em um intervalo especificado. Atualmente, somente o Credenciais do Cliente A versão do OAuth2 é compatível. |
Este guia fornece uma visão geral de alto nível de como configurar segredos para um encaminhamento de evento (Edge) na interface do usuário da coleta de dados.
Para obter orientações detalhadas sobre como gerenciar segredos na API do Reator, incluindo o JSON da estrutura de um segredo, consulte guia da API de segredos.
Este guia pressupõe que você já esteja familiarizado com o gerenciamento de recursos para tags e encaminhamento de eventos na interface do usuário da coleta de dados, incluindo como criar um elemento de dados e uma regra de encaminhamento de eventos. Consulte o guia sobre gerenciamento de recursos se você precisar de uma introdução.
Você também deve ter uma compreensão funcional do fluxo de publicação para tags e encaminhamento de eventos, incluindo como adicionar recursos a uma biblioteca e instalar uma build em seu site para testes. Consulte a visão geral da publicação para obter mais detalhes.
Para criar um segredo, faça logon na interface do usuário da Coleta de dados e abra a propriedade de encaminhamento de eventos em que deseja adicionar o segredo. Em seguida, selecione Segredos no painel de navegação esquerdo, seguido de Criar novo segredo.
A próxima tela permite configurar os detalhes do segredo. Para que um segredo possa ser usado pelo encaminhamento de eventos, ele deve ser atribuído a um ambiente existente. Se você não tiver nenhum ambiente criado para sua propriedade de encaminhamento de evento, consulte o guia em ambientes para obter orientação sobre como configurá-los antes de continuar.
Se você ainda quiser criar e salvar o segredo antes de adicioná-lo a um ambiente, desative o Anexar segredo a ambientes alternar antes de preencher o restante das informações. Observe que você terá que atribuí-lo a um ambiente posteriormente se quiser usar o segredo.
Em Ambiente do Target, use o menu suspenso para selecionar o ambiente ao qual deseja atribuir o segredo. Em Nome secreto, forneça um nome para o segredo no contexto do ambiente. Esse nome deve ser exclusivo em todos os segredos na propriedade de encaminhamento de eventos.
Um segredo só pode ser atribuído a um ambiente por vez, mas você pode atribuir as mesmas credenciais a vários segredos em ambientes diferentes, se desejar. Selecionar Adicionar ambiente para adicionar outra linha à lista.
Para cada ambiente adicionado, você deve fornecer outro nome exclusivo para o segredo associado. Se você esgotar todos os ambientes disponíveis, a variável Adicionar ambiente não estará disponível.
A partir daqui, as etapas para criar o segredo diferem dependendo do tipo de segredo que você está criando. Consulte as subseções abaixo para obter detalhes:
Para criar um segredo de token, selecione Token do Tipo lista suspensa. No Token , forneça a cadeia de caracteres de credencial reconhecida pelo sistema ao qual você está autenticando. Selecionar Criar segredo para salvar o segredo.
Para criar um segredo HTTP, selecione HTTP simples do Tipo lista suspensa. Nos campos que aparecem abaixo, forneça um nome de usuário e senha para a credencial antes de selecionar Criar segredo para salvar o segredo.
Ao ser salva, a credencial é codificada usando a variável Esquema de autenticação HTTP "básico".
Para criar um segredo OAuth2, selecione OAuth2 do Tipo lista suspensa. Nos campos que aparecem abaixo, forneça seu ID do cliente e Segredo do cliente, bem como seu URL de autorização para sua integração com o OAuth. O URL de autorização na interface do usuário da coleta de dados é uma concatenação entre o host do servidor de autorização e o caminho do token.
Em Opções de Credencial, você pode fornecer outras opções de credencial, como scope
e audience
na forma de pares de valores-chave. Para adicionar mais pares de valores chave, selecione Adicionar outro.
Por fim, você pode configurar a variável Atualizar Deslocamento para o segredo. Representa o número de segundos antes da expiração do token em que o sistema executará uma atualização automática. O tempo equivalente em horas e minutos é exibido à direita do campo e é atualizado automaticamente à medida que você digita.
Por exemplo, se o deslocamento de atualização estiver definido como o valor padrão de 14400
(quatro horas) e o token de acesso tem um expires_in
valor de 86400
(24 horas), o sistema atualizará automaticamente o segredo em 20 horas.
Um segredo OAuth requer pelo menos quatro horas entre as atualizações e também deve ser válido por no mínimo oito horas. Essa restrição oferece um mínimo de quatro horas para intervir se surgirem problemas com o token gerado.
Por exemplo, se o deslocamento estiver definido como 28800
(oito horas) e o token de acesso tem um expires_in
de 36000
(dez horas), a troca falharia porque a diferença resultante era menor que quatro horas.
Quando terminar, selecione Criar segredo para salvar o segredo.
Depois de criar segredos para uma propriedade, você pode encontrá-los listados na Segredos espaço de trabalho. Para editar os detalhes de um segredo existente, selecione seu nome na lista.
A próxima tela permite alterar o nome e as credenciais do segredo.
Se o segredo estiver associado a um ambiente existente, você não poderá reatribuir o segredo a outro ambiente. Se desejar usar as mesmas credenciais em um ambiente diferente, será necessário criar um novo segredo em vez disso. A única maneira de reatribuir o ambiente a partir desta tela é se você nunca atribuiu o segredo a um ambiente antecipadamente ou se excluiu o ambiente ao qual o segredo foi anexado.
Você pode tentar novamente ou atualizar uma troca secreta na tela de edição. Esse processo varia dependendo do tipo de segredo que está sendo editado:
Tipo de segredo | Repetir protocolo |
---|---|
Token | Selecionar Exchange Secret para tentar novamente a troca secreta. Esse controle só está disponível quando há um ambiente anexado ao segredo. |
HTTP | Se não houver nenhum ambiente anexado ao segredo, selecione Exchange Secret para trocar a credencial para base64. Se um ambiente estiver anexado, selecione Selecionar Trocar e Implantar Segredo para trocar para base64 e implantar o segredo. |
OAuth2 | Selecionar Gerar token para trocar as credenciais e retornar um token de acesso do provedor de autenticação. |
Para excluir um segredo existente no Segredos na área de trabalho, marque a caixa de seleção ao lado do nome antes de selecionar Excluir.
Para usar um segredo no encaminhamento de eventos, primeiro crie um elemento de dados que faz referência ao próprio segredo. Depois de salvar o elemento de dados, você pode incluí-lo no encaminhamento do evento regras e adicionar essas regras a um biblioteca, que, por sua vez, pode ser implantado em servidores do Adobe como um build.
Ao criar o elemento de dados, selecione o Núcleo e selecione Segredo para o tipo de elemento de dados. O painel direito atualiza e fornece controles suspensos para atribuir até três segredos ao elemento de dados: um para Desenvolvimento, Estágiose Produção respectivamente.
Somente os segredos anexados aos ambientes de desenvolvimento, armazenamento temporário e produção são exibidos para seus respectivos detalhamentos.
Ao atribuir vários segredos a um único elemento de dados e incluí-lo em uma regra, você pode ter o valor do elemento de dados alterado, dependendo de onde a biblioteca que contém está no fluxo de publicação.
Ao criar o elemento de dados, um ambiente de desenvolvimento deve ser atribuído. Os segredos dos ambientes de armazenamento temporário e produção não são necessários, mas as criações que tentarem fazer a transição para esses ambientes falharão se os elementos de dados do tipo secreto não tiverem um segredo selecionado para o ambiente em questão.
Este guia cobriu como gerenciar segredos na interface do usuário da coleta de dados. Para obter informações sobre como interagir com segredos usando a API do Reator, consulte o guia do endpoint de segredos.