Ir para o conteúdo principal

Gerando e gerenciando tokens de API

O recurso Token de API permite integrar o sistema com outras plataformas e serviços de forma segura. Cada token funciona como uma “chave digital” que autoriza a comunicação entre sistemas, valendo lembrar que somente liberamos o uso da API, toda a integração deve ser feita por um desenvolvedor seu ou independente.


Acessando os Tokens de API

Para acessar os tokens cadastrados vá em: Menu Lateral do Sistema → Configuração → Integração → Tokens de API

API1.gif

Na tela, você encontrará a listagem com as seguintes colunas:

  • Descrição → nome dado por você ao token para facilitar a identificação da integração.
  • Expiração → data e hora em que o token perderá a validade.
  • Token → chave única gerada para a integração (pode ser exibida clicando em Mostrar Token).
  • Grupo → grupo de permissões vinculado ao token, determinando quais dados poderão ser acessados.
  • Criação → data em que o token foi gerado no sistema.

Explicação da tela de Tokens de API

image.png

Na parte superior da tela, você encontra os seguintes botões:

  • Buscar → pesquisa um token já existente.
  • Cadastrar → cria um novo token.
  • Remover → exclui tokens que não são mais necessários.
  • Documentação → acesso às instruções técnicas de integração ou seja acesso a toda a documentação da API

Gerar um Novo Token

API12.gif

  1. Clique em Cadastrar.
  2. Informe a Descrição (nome da integração).
  3. Defina o Grupo de permissões para limitar o acesso.
  4. Salve e copie o Token gerado para configurar na aplicação externa.

Informações importantes:

Para ter acesso a API liberada você deverá ter contratado em seu plano, se você não tem basta solicitar ao time financeiro.

Você também pode ter acesso a documentação da API clicando em "Documentação" ou clicando aqui