Gerenciando tokens de acesso

Crie ou gerencie seus tokens de acesso da Diligent One pessoais na página Gerenciar tokens da API, disponível na página do perfil do Launchpad.

O que é um token de acesso?

Um token de acesso é uma cadeia de caracteres que identifica um usuário e autentica o acesso a outros aplicativos.

O token de acesso necessário depende do que você precisa fazer:

• Importar dados do Projetos da Diligent One para o Analytics — token da API do Analytics ou do HighBond
• Importar dados do Resultados do Diligent One para o Analytics — token da API do Analytics ou do HighBond
• Exportar dados do Resultados do Diligent One a partir do Analytics — token da API do Analytics ou do HighBond
• Obter acesso programático ao Diligent One — token da API do HighBond
• Receber acesso programático aos logs de atividades do Launchpad — token da API de Logs de Atividades

  Observação

  O acesso ao log de atividades do Launchpad está disponível apenas para administradores do sistema.

Token do Analytics

O token do Analytics é gerado automaticamente sempre que você ativar o Analytics e é armazenado no seu registro.

• Se você estiver usando o Analytics 14 ou uma versão anterior e criar manualmente um Token de Acesso ACLGRC, o token será categorizado no Launchpad como um tipo de token do Analytics.
• Se você estiver usando o Analytics 14.1 e criar manualmente um Token de Acesso da Diligent One, o token será categorizado no Launchpad como um tipo de token do Analytics.

Como funciona?

No Launchpad, a página Gerenciar tokens da API exibe todos os tokens de acesso que você gerou.

Você pode usar a página Gerenciar tokens da API para:

• copiar seus tokens
• fornecer um rótulo para descrever ou identificar os tokens de acesso
• bloquear tokens de acesso para evitar que eles sejam modificados ou excluídos
• excluir tokens de acesso

Permissões

Qualquer usuário pode criar um token do Analytics. Você deve ser Administrador do Sistema em pelo menos uma instância do Diligent One para criar um token de API do HighBond ou um token de API de Logs de Atividades.

Todos os usuários podem gerenciar os próprios tokens de acesso.

Criar tokens de acesso

1. Abra a página inicial do Launchpad (www.highbond.com).

   Se a sua empresa usa mais de uma instância no Launchpad, verifique se a instância apropriada está ativa.

2. Selecione > Meu perfil.
3. Ao lado de Tokens de aplicativos, clique em Gerenciar. A página Gerenciar Tokens da API abre.
4. Clique em +Adicionar token e selecione a opção adequada no menu suspenso (por exemplo, API do HighBond, Analytics ou API de Logs de Atividades). É exibido o painel lateral Novo token.
5. Preencha os campos no painel lateral para criar um token.

   Observação

   Todos os campos são obrigatórios para criar um token, incluindo o campo Descrição. A única exceção será se você optar por não incluir a expiração do token. Nesse caso, não é necessário preencher o número de dias até a expiração de um token, pois o padrão é Nunca.

   1. Insira uma descrição.

      Dica

      Na descrição, inclua todos os locais onde esse token será usado e sua finalidade. O motivo é que os tokens precisam ser substituídos quando expiram. Uma descrição detalhada ajuda a poupar tempo e esforço na hora da substituição.

   2. Opcional. Ative ou desative a expiração do token.

      Observação

      A capacidade de definir a expiração do token deve estar ativada (habilitada) por padrão. Se estiver desativada, o token nunca vai expirar.

   3. Insira o número de dias até a expiração do token. O máximo é um ano (365 dias) após a data da criação do token.
   4. Insira a senha da sua conta da Diligent One para verificar sua identidade.
6. Clique em Gerar token. O painel lateral é atualizado com uma mensagem que confirma que seu token foi gerado com sucesso e inclui o ID do token, a data de expiração (a data e o horário em que o token vai expirar) e a Descrição.
7. Clique em Copiar. Uma mensagem Copiado para a área de transferência confirma que o token foi copiado com sucesso.

   Cuidado

   Salve seu token antes de fechar o painel lateral. Por questões de segurança, esta é a sua única oportunidade de ter acesso a ele. Se você não salvar seu token e esquecê-lo, precisará criar um novo.
8. Clique em Fechar. O painel lateral Novo token é fechado.
9. Cole o token em um aplicativo ou script.

   Observação

   Trate o token como uma senha. Não o compartilhe com outras pessoas.

Localizar e utilizar tokens de acesso

Na página Gerenciar tokens de API, você pode encontrar tokens existentes, editar descrições de tokens, bloquear tokens para que não possam ser editados ou excluídos e excluir tokens.

1. Abra a página inicial do Launchpad (www.highbond.com).

   Se a sua empresa usa mais de uma instância no Launchpad, verifique se a instância apropriada está ativa.

2. Selecione > Meu perfil.
3. Ao lado de Tokens de aplicativos, clique em Gerenciar. A página Gerenciar Tokens da API abre.
4. Conclua qualquer uma das ações a seguir.

Encontrar tokens de acesso

Para localizar tokens, você pode pesquisar, ordenar e filtrar para encontrar os tokens específicos de que precisa. Execute qualquer uma das seguintes ações:

• Pesquisar tokens: insira os primeiros caracteres do token de acesso (até sete caracteres) na barra de pesquisa. Isso gera uma lista restrita de resultados.
• Classificar tokens: clique no cabeçalho de qualquer coluna para ordenar os tokens pela coluna escolhida, em ordem ascendente ou descendente.
• Filtrar tokens: por padrão, todos os tokens gerados são exibidos. No entanto, você pode filtrar a lista de tokens para um subconjunto (por exemplo, se o token está bloqueado) ou pelo tipo de token: Analytics, Logs de atividades ou API do HighBond. Selecione os filtros desejados nos menus suspensos disponíveis para filtrar a lista de tokens. Clique em Limpar para remover todos os filtros.

Copiar um token de acesso existente

1. Clique no token truncado e insira a senha do Diligent One. É exibida a caixa de diálogo Confirme sua senha.
2. Insira a senha para verificar sua identidade.
3. Clique em Confirmar. É exibida uma caixa de diálogo com seu token.
4. Clique em Copiar. Uma mensagem Copiado para a área de transferência confirma que o token foi copiado com sucesso.
5. Feche a caixa de diálogo.
6. Agora, você pode colar o token em um aplicativo ou script.

Editar a descrição de um token de acesso

1. Clique no lápis . O campo Descrição se torna editável em linha.
2. Faça atualizações na descrição e clique na marca de verificação para salvar as alterações. A descrição atualizada aparece na tabela.

Bloquear ou desbloquear tokens de acesso

Para evitar que tokens sejam excluídos e descrições de tokens sejam editadas, você pode bloqueá-los. Também é possível desbloquear os tokens para alterar as descrições e ativar a exclusão.

• Clique no cadeado aberto ao lado do seu token para desativar a exclusão de tokens e a edição das descrições. O cadeado aparece fechado para indicar que não é possível editar ou excluir o token. O lápis e o ícone da lixeira também desaparecem.
• Clique no cadeado fechado para desbloquear o token e ativar a exclusão de tokens e a edição das descrições. O cadeado aparecerá aberto para indicar que a edição e a exclusão estão ativadas. O lápis e o ícone da lixeira também reaparecem.

Excluir tokens de acesso

Você pode excluir tokens únicos, vários tokens de uma vez ou todos os tokens na lista. Se você não precisa manter tokens anteriores para referência, pode excluí-los para remover a desordem da lista de tokens. No entanto, a decisão de excluir tokens deve ser tomada com cuidado e posta em prática somente depois de confirmar que o token não precisa mais ser usado em outro local. Isso porque a exclusão é permanente e não pode ser desfeita.

Excluir um único token

1. Clique no ícone de lixeira ao lado do token. É exibida a caixa de diálogo Excluir # token? para você confirmar a exclusão.
2. Clique em Excluir token. O token é excluído permanentemente e removido da lista.

Cuidado

A exclusão de um token é permanente e não pode ser desfeita. Se o token estiver em uso quando for excluído, qualquer processo relacionado falhará. Se um token for excluído por engano, será necessário recriá-lo e reintroduzi-lo no aplicativo ou script afetado.

Excluir vários tokens

1. Clique nas caixas de seleção ao lado dos tokens que deseja excluir. Um botão vermelho aparecerá acima da lista de tokens, indicando o número de tokens que serão excluídos.
2. Clique em Excluir # tokens. É exibida a caixa de diálogo Excluir # token? para você confirmar a exclusão.
3. Clique em Excluir tokens. Os tokens são excluídos permanentemente e removidos da lista.

Cuidado

A exclusão de um token é permanente e não pode ser desfeita. Se o token estiver em uso quando for excluído, qualquer processo relacionado falhará. Se um token for excluído por engano, será necessário recriá-lo e reintroduzi-lo no aplicativo ou script afetado.

Excluir todos os tokens

1. Marque a caixa de seleção ao lado do ícone de informações . Isso seleciona automaticamente todos os tokens na lista. Um botão vermelho aparecerá acima da lista de tokens, indicando o número de tokens que serão excluídos.
2. Clique em Excluir # tokens. É exibida a caixa de diálogo Excluir # tokens? para você confirmar a exclusão.
3. Clique em Excluir # tokens. Os tokens são excluídos permanentemente e removidos da lista.

Cuidado

A exclusão de um token é permanente e não pode ser desfeita. Se o token estiver em uso quando for excluído, qualquer processo relacionado falhará. Se um token for excluído por engano, será necessário recriá-lo e reintroduzi-lo no aplicativo ou script afetado.

Lidar com tokens que estão expirando

Quando um token está prestes a expirar, os criadores do token recebem e-mails com 30 dias, cinco dias e um dia de antecedência. Um e-mail final é enviado após a expiração. Os e-mails continuam a ser enviados até que o token seja excluído ou expire. Quando ele expira, todos os processos dependentes falham, a menos que seja substituído.

Substituir um token que está expirando por um novo

Para evitar a falha dos processos, os tokens que estão expirando e os expirados precisam ser substituídos por novos. Para atualizar um token, será necessário criar um novo. Consulte Criar tokens de acesso. Após criar um novo token, localize todas as instâncias que usam o token que está expirando e substitua esse token por um recém-criado.

Excluir um token que está expirando

Exclua um token que está expirando para deixar de receber notificações sobre uma expiração próxima e para remover os tokens que não precisa mais consultar. Consulte Excluir tokens de acesso.