Configuração de segredos no encaminhamento de eventos
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.
Os seguintes tipos secretos são suportados no momento:
Este guia fornece uma visão geral de alto nível sobre como configurar segredos para uma propriedade de encaminhamento de eventos (Edge) na interface do usuário do Experience Platform ou na interface da Coleção de dados.
Pré-requisitos
Este guia pressupõe que você já esteja familiarizado com a forma de gerenciar recursos para tags e encaminhamento de eventos na interface do usuário, 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 de tags e do encaminhamento de eventos, incluindo como adicionar recursos a uma biblioteca e instalar uma build no site para teste. Consulte a visão geral da publicação para obter mais detalhes.
Criar um segredo create
Para criar um segredo, selecione Event Forwarding na navegação à esquerda e abra a propriedade de encaminhamento de eventos em que deseja adicionar o segredo. Em seguida, selecione Secrets na navegação à esquerda, seguido por Create New Secret.
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 a propriedade de encaminhamento de eventos, consulte o manual em ambientes para obter orientação sobre como configurá-los antes de continuar.
Em Target Environment, use o menu suspenso para selecionar o ambiente ao qual deseja atribuir o segredo. Em Secret Name, 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. Selecione Add Environment para adicionar outra linha à lista.
Para cada ambiente adicionado, é necessário fornecer outro nome exclusivo para o segredo associado. Se você esgotar todos os ambientes disponíveis, o botão Add Environment não estará disponível.
Aqui, as etapas para criar o segredo diferem dependendo do tipo de segredo que está sendo criado. Consulte as subseções abaixo para obter detalhes:
Token token
Para criar um segredo de token, selecione Token na lista suspensa Type. No campo Token exibido, forneça a cadeia de caracteres de credencial reconhecida pelo sistema no qual você está autenticando. Selecione Create Secret para salvar o segredo.
HTTP http
Para criar um segredo HTTP, selecione Simple HTTP na lista suspensa Type. Nos campos que aparecem abaixo, forneça um nome de usuário e senha para a credencial antes de selecionar Create Secret para salvar o segredo.
OAuth 2 oauth2
Para criar um segredo do OAuth 2, selecione OAuth 2 na lista suspensa Type. Nos campos que aparecem abaixo, forneça seu Client ID e Client Secret, bem como seu Token URL para sua integração com o OAuth. O campo Token URL na interface é uma concatenação entre o host do servidor de autorização e o caminho do token.
Em Credential Options, você pode fornecer outras opções de credencial, como scope e audience, na forma de pares de valores chave. Para adicionar mais pares de valor-chave, selecione Add another.
Finalmente, você pode configurar o valor Refresh Offset do 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 com o valor padrão de 14400 (quatro horas) e o token de acesso tiver um valor de expires_in de 86400 (24 horas), o sistema atualizará automaticamente o segredo em 20 horas.
28800 (oito horas) e o token de acesso tiver um expires_in de 36000 (dez horas), a troca falhará devido à diferença resultante ser inferior a quatro horas.Quando terminar, selecione Create Secret para salvar o segredo.
OAuth 2 JWT oauth2jwt
Para criar um segredo JWT do OAuth 2, selecione OAuth 2 JWT na lista suspensa Type.
Nos campos que aparecem abaixo, forneça seu Issuer, Subject, Audience, Custom Claims, TTL e selecione o Algorithm na lista suspensa. Em seguida, insira o Private Key Id, bem como o Token URL para a integração OAuth. O campo Token URL não é obrigatório. Se um valor for fornecido, o JWT será trocado com um token de acesso. O segredo será atualizado de acordo com o atributo expires_in da resposta e o valor Refresh Offset. Se um valor não for fornecido, o segredo enviado para a borda será o JWT. O JWT será atualizado de acordo com os valores TTL e Refresh Offset.
Em Credential Options, você pode fornecer outras opções de credencial, como jwt_param, na forma de pares de valores chave. Para adicionar mais pares de valor-chave, selecione Add another.
Finalmente, você pode configurar o valor Refresh Offset do 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 com o valor padrão de 1800 (30 minutos) e o token de acesso tiver um valor de expires_in de 3600 (uma hora), o sistema atualizará automaticamente o segredo em uma hora.
1800 (30 minutos) e o token de acesso tiver um expires_in de 2700 (45 minutos), a troca falhará devido à diferença resultante ser inferior a 30 minutos.Quando terminar, selecione Create Secret para salvar o segredo.
Google OAuth 2 google-oauth2
Para criar um segredo OAuth 2 do Google, selecione Google OAuth 2 na lista suspensa Type. Em Scopes, selecione as APIs do Google às quais você deseja usar este segredo para conceder acesso. Os seguintes produtos são suportados no momento:
Quando terminar, selecione Create Secret.
Um popover é exibido informando que o segredo precisa ser autorizado manualmente por meio do Google. Selecione Create & Authorize para continuar.
Uma caixa de diálogo é exibida, permitindo inserir as credenciais da conta da Google. Siga as instruções para conceder acesso ao encaminhamento de eventos para seus dados no escopo selecionado. Quando o processo de autorização estiver concluído, o segredo será criado.
LinkedIn OAuth 2 linkedin-oauth2
Para criar um segredo OAuth 2 LinkedIn, selecione LinkedIn OAuth 2 na lista suspensa Type. Em seguida, selecione Create Secret.
Um popover é exibido informando que o segredo precisa ser autorizado manualmente por meio do LinkedIn. Selecione Create & Authorize secret with LinkedIn para continuar.
Uma caixa de diálogo é exibida solicitando que você insira suas credenciais do LinkedIn. Siga as instruções para conceder acesso ao encaminhamento de eventos para seus dados.
Quando o processo de autorização for concluído, você retornará à guia Secrets, onde poderá ver o segredo recém-criado. Aqui você pode ver o status do segredo e a data de expiração.
Reautorizar um segredo de LinkedIn OAuth 2
IMPORTANTE
Você precisa reautorizar usando suas credenciais do LinkedIn a cada 365 dias. Se você não reautorizar em tempo hábil, seu segredo não será atualizado e as solicitações de conversão do LinkedIn falharão.
Três meses antes do segredo que requer reautorização, um pop-up começará a ser exibido quando você estiver navegando em qualquer página da propriedade. Selecione Click here to go to your secrets.
Você será redirecionado para a guia Secrets. Os segredos listados nesta página são filtrados para mostrar apenas os segredos que precisam ser reautorizados. Selecione Auth Needed para o segredo que você precisa reautorizar.
Uma caixa de diálogo é exibida solicitando que você insira suas credenciais do LinkedIn. Siga as instruções para reautorizar o segredo.
Amazon OAuth 2 amazon-oauth2
Para criar um segredo OAuth 2 Amazon, selecione Amazon OAuth 2 na lista suspensa Type. Em seguida, selecione Create Secret.
Um popover é exibido informando que o segredo precisa ser autorizado manualmente por meio do Amazon. Selecione Create & Authorize secret with Amazon para continuar.
Uma caixa de diálogo é exibida solicitando que você insira suas credenciais do Amazon. Siga as instruções para conceder acesso ao encaminhamento de eventos para seus dados.
Quando o processo de autorização for concluído, você retornará à guia Secrets, onde poderá ver o segredo recém-criado. Aqui você pode ver o status do segredo e a data de expiração.
Editar um segredo
Após criar segredos para uma propriedade, você pode encontrá-los listados no espaço de trabalho Secrets. Para editar os detalhes de um segredo existente, selecione o nome na lista.
A próxima tela permite alterar o nome e as credenciais do segredo.
Tentar novamente uma troca secreta
Você pode tentar novamente ou atualizar uma troca de segredo na tela de edição. Esse processo varia dependendo do tipo de segredo que está sendo editado:
Excluir um segredo
Para excluir um segredo existente no espaço de trabalho Secrets, marque a caixa de seleção ao lado de seu nome antes de selecionar Delete.
Uso de segredos no encaminhamento de eventos
Para usar um segredo no encaminhamento de eventos, primeiro você deve criar um elemento de dados que faça referência ao próprio segredo. Depois de salvar o elemento de dados, você pode incluí-lo no encaminhamento de eventos regras e adicionar essas regras a uma biblioteca, que, por sua vez, pode ser implantada nos servidores da Adobe como uma compilação.
Ao criar o elemento de dados, selecione a extensão Core e Secret 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 Development, Staging e Production, respectivamente.
Atribuindo vários segredos a um único elemento de dados e incluindo uma regra, você pode fazer com que o valor do elemento de dados seja alterado, dependendo de onde a biblioteca que contém está no fluxo de publicação.
Próximas etapas
Este guia aborda como gerenciar segredos na interface do usuário do. Para obter informações sobre como interagir com segredos usando a API do Reator, consulte o manual de endpoint de segredos.