Page cover

Autenticação

Aqui vamos demonstrar como gerar o token de autenticação para a API v2.

🔑 Autenticação e Geração de Token (API v2)

📍 Localização:
📂 Configurações > Usuários > Usuários | Configurações > Minha conta > Sessões

🎯 Introdução

A API v2 do Tiflux utiliza um modelo de autenticação baseado em tokens individuais por usuário. Este procedimento garante que cada integração possua as mesmas permissões e rastreabilidade do usuário vinculado, oferecendo uma camada extra de segurança e controle. O valor agregado desta configuração é a possibilidade de automatizar processos e integrar sistemas externos de forma segura e personalizada.


📚 Sumário

🧾 Requisitos de Licenciamento

🛠️ Atribuição da Licença ao Usuário

🧪 Gerando o Token de Acesso

📊 Gestão de Sessões de API

🔄 Renovação e Segurança do Token


📘 Conteúdo dividido em seções com emojis temáticos

🧾 Requisitos de licenciamento

Diferente das versões anteriores, a autenticação na API v2 é vinculada diretamente ao perfil do colaborador. Para que o sistema permita a geração de chaves de acesso, o usuário em questão deve obrigatoriamente possuir a licença "API por usuário" ativa em seu cadastro. Sem esta atribuição, as abas de geração de token permanecerão ocultas ou desabilitadas.

🛠️ Atribuição da licença ao usuário

Para habilitar o recurso, um administrador deve seguir este fluxo:

  1. Acesse Configurações > Usuários > Usuários.

  2. Localize e edite o usuário que realizará a integração.

  3. Na aba de licenças, marque a opção "API por usuário".

  4. Clique em Salvar para aplicar as alterações.

🧪 Gerando o token de acesso

Com a licença atribuída, o próprio usuário deve gerar sua credencial:

  1. Navegue até Configurações > Minha conta.

  2. Clique sobre a aba Sessões e localize o bloco intitulado Sessões API.

  3. Clique no botão "Gerar novo token de sessão" e confirme em "Gerar novo token".

  4. O sistema exibirá o token em uma janela única. Copie e armazene-o em local seguro imediatamente.

🔄 Renovação e segurança do token

Os tokens de sessão são chaves de acesso poderosas. Caso o token seja comprometido ou perdido, ele deve ser revogado imediatamente na lista de sessões de API. Como o sistema não permite a visualização do código após o fechamento da tela de geração, o esquecimento da chave exigirá a criação de um novo token, o que invalidará o anterior em suas aplicações.


⚠️ Avisos importantes

Exibição Única: O token de autenticação é exibido apenas uma vez no momento da criação. Por questões de segurança, o Tiflux não armazena o texto simples da chave em seus bancos de dados para consulta posterior.

Segurança: Jamais compartilhe seu token de API em chats, e-mails ou fóruns públicos. Ele concede acesso total às funcionalidades permitidas ao seu usuário.


❓ Perguntas Frequentes (FAQ)

🔹 Por que não consigo ver a aba "Sessões API"? Provavelmente a licença "API por usuário" não foi atribuída ao seu cadastro nas configurações de usuários.

🔹 Posso ter mais de um token ativo ao mesmo tempo? Sim, você pode gerar múltiplos tokens para diferentes integrações sob o mesmo usuário.

🔹 O que acontece se eu excluir um token na lista de sessões? A integração que utiliza aquele token específico deixará de funcionar imediatamente (Erro 401 Unauthorized).

🔹 O token expira sozinho? Os tokens de API v2 geralmente não possuem expiração automática, a menos que sejam revogados manualmente ou o usuário seja inativado.

🔹 Perdi meu token, onde consulto ele? Não é possível consultar. Você deve gerar um novo token e atualizar sua aplicação.

🔹 A licença de API consome um slot de técnico? A licença de API é um recurso adicional que se atrela a um usuário técnico já existente.

🔹 O token tem as mesmas permissões que eu tenho no sistema? Sim, o token atua com o mesmo nível de permissão (Perfil de Acesso) do usuário que o gerou.

🔹 Consigo gerar um token para outro usuário? Não, cada usuário deve logar em sua própria conta para gerar seu token pessoal na aba "Minha Conta".

🔹 Como identifico qual token pertence a qual integração? Ao gerar, você pode identificar a sessão pela data de criação e pelo último uso na lista de sessões.

🔹 A API v1 continua funcionando com este token? Não, este procedimento é exclusivo para a arquitetura da API v2 do Tiflux.


🔍 Palavras-chave para IA, indexação e busca

Markdown

1. Requisitos:

Como a autenticação na API v2 é feita por usuário, o seu usuário do Tiflux deverá possuir atrelado a ele a licença de "API por usuário".

Para atribuir a licença ao usuário, você deverá acessar Configurações > Usuários > Usuários, localizar e acessar o usuário desejado, e marcar a licença "API por usuário", conforme ilustra a imagem abaixo:

2. Gerando o token de autenticação:

Para gerar o token de acesso à API v2, acesse as configurações da sua conta em: Configurações > Minha conta:

Dentro da tela de configurações da sua conta, clique sobre a aba "Sessões" e localize a sessão "Sessões API":

Para criar um novo token, clique em "Gerar novo token de sessão" e, em seguida, em "Gerar novo token":

Após concluir o procedimento descrito acima, o seu token de autenticação da API será gerado. Na tela seguinte, você poderá visualizar e copiar o token:

Pronto! O token da API do seu usuário está criado e pronto para uso.

Atualizado