O token de API é uma chave de autenticação que permite que sistemas externos se conectem com a plataforma da Kobana de forma segura.
Com ele, você pode integrar seu ERP, site ou qualquer outro sistema com as funcionalidades da Kobana, automatizando operações como emissão de boletos, consulta de pagamentos e muito mais.
Neste artigo, vamos mostrar o que é o token de API, para que serve e como encontrá-lo na sua conta da Kobana.
Quer conhecer mais sobre as possibilidades da API da Kobana? Confira nossa documentação completa para desenvolvedores!
O que é o token de API?
O token de API é uma sequência de caracteres única que funciona como uma "senha" para identificar e autenticar sua conta da Kobana quando um sistema externo faz uma requisição.
É por ele que a Kobana reconhece que a requisição é legítima e autoriza o acesso às funcionalidades.
Encontrando os Tokens de API na Kobana
Para visualizar e criar tokens de API para a sua conta, logado na Kobana, acesse o menu Integrações > API (Seu sistema -> Kobana) > Tokens de API.
Nesta tela, você poderá visualizar todos os tokens, ver os escopos, último uso, validade, entre outras informações.
Criando um novo token
Para criar um token, você vai acessar a tela dos tokens (passo a passo acima) e clicar em Novo Token de API.
Durante a criação, você vai precisar definir:
Descrição: inclua uma descrição completa do token que você está criando, como nome do sistema e escopos.
Escopos: selecione o mínimo de escopos necessários. Isso aumenta a segurança do seu token.
Nível de acesso: defina se o seu token apenas realizará a consulta de informações ou se ele, também, vai alterar dados e executar ações.
Validade: recomendamos, por motivos de segurança, que sempre defina uma validade ao seu token, que poderá ser estendida a qualquer momento. Se a validade for definida, você poderá incluir endereços de e-mails a serem notificados quando estiver próximo do vencimento.
Ao clicar em Criar Token, disponibilizaremos o token que você deverá salvar de forma segura e imediata. O token não será disponibilizado novamente. Caso seja perdido, você deverá renová-lo
Renovando o token de API
Caso seja necessário, você pode renovar seu token de API. Para isso, na página principal dos tokens, clique no botão Renovar Token no token específico que deseja realizar esta ação.
Importante! Ao renovar o token, o anterior deixa de funcionar imediatamente, o que significa que todas as integrações feitas com aquele token também deixam de funcionar. Certifique-se de atualizar todos os sistemas que usam a integração com o novo token.
Dicas de segurança para o token de API
Mantenha o token seguro: Nunca compartilhe seu token em repositórios públicos, e-mails ou chats;
Use variáveis de ambiente: Em aplicações, armazene o token em variáveis de ambiente, não diretamente no código;
Monitore o uso: Acompanhe regularmente os logs de API para identificar uso indevido;
Renove quando necessário: Se suspeitar que o token foi comprometido, renove imediatamente;
Permissões adequadas: Certifique-se de que o usuário que gerou o token possui apenas as permissões necessárias;
Escopo mínimo: Ao criar um token sempre define o mínimo de escopos necessários para a sua integração.
Precisa de ajuda? Nossa equipe de suporte está sempre disponível no chat da plataforma ou pelo e-mail suporte@kobana.com.br para auxiliar com sua integração.