Como gerar um token de integração

Sumário

• Nesse artigo você vai aprender
• Descrição
• Pré-requisito
• Como gerar um token de integração
• Como utilizar o token de integração nas chamadas da API
• Dúvidas mais comuns

⚓ 

Nesse artigo você vai aprender

Nesse artigo você vai aprender os passos necessários para gerar um token de integração e utilizá-lo para realizar chamadas na API REST do Pontta.

⚓ 

Descrição

O token de integração é a credencial utilizada para autenticar chamadas externas na API do Pontta. Ele é sempre vinculado a um usuário do sistema e herda automaticamente as permissões e a empresa (tenant) desse usuário, ou seja, uma integração autenticada com o token atua exatamente com os mesmos acessos e configurações que o usuário vinculado possui no ERP. Também é possível restringir quais endereços de IP podem utilizar o token, aumentando a segurança da integração.

⚓ 

Pré-requisito

Para gerar, ativar, desativar ou remover tokens de integração, o usuário precisa possuir a permissão administrativa de gerenciamento de tokens de integração.

⚓ 

Como gerar um token de integração

    1 - Acesse o menu "Módulo Administrativo".

    2 - Clique na aba "Usuário".

    3 - Selecione a opção "Tokens de integração".

    4 - Clique no botão "+" para gerar um novo token.

    5 - Vincule o usuário ao qual o token será gerado. Lembrando que as permissões que poderão ser utilizadas através do token são as mesmas que esse usuário possui.

    6 - Caso queira, informe os IPs que terão permissão para utilizar esse token. Se preferir liberar o uso para qualquer IP, deixe o campo em branco.

    7 - Clique em "Criar".

    8 - Copie e salve o token gerado imediatamente. Ele só é exibido nesse primeiro momento: se a página for recarregada ou você sair e entrar novamente na tela, o token não será mais apresentado.

⚓ 

Como utilizar o token de integração nas chamadas da API

    1 - Codifique o token gerado em Base64.

    2 - Para chamadas onde você pode manipular livremente o cabeçalho da requisição, informe o cabeçalho Authorization no formato Basic <token codificado em Base64>.

    3 - Para integrações onde é necessário informar um usuário e uma senha para gerar o Basic token, informe o token de integração como usuário e deixe a senha em branco (ou informe qualquer valor, pois ela será ignorada).

    4 - Execute a autenticação e, a partir daí, já é possível realizar as chamadas necessárias na API.

Observação: o Pontta utiliza o padrão Basic Authentication para o uso do token de integração.

⚓ 

Dúvidas mais comuns

As permissões do token de integração são as mesmas de quem criou o token?

Não. As permissões vinculadas ao token são sempre as mesmas do usuário selecionado no campo "usuário vinculado" no momento da criação.

É possível restringir o token para funcionar apenas em determinados IPs?

Sim. No momento da criação (ou posteriormente, editando o token) é possível informar os IPs que terão permissão para utilizá-lo. Deixando o campo em branco, o token pode ser utilizado a partir de qualquer IP.

Perdi o token gerado antes de copiá-lo, o que eu faço?

Não é possível recuperar um token depois que ele deixa de ser exibido na tela. Nesse caso, remova o token antigo e gere um novo token de integração seguindo o mesmo processo.

Como desativar, editar os IPs permitidos ou remover um token já criado?

Na listagem de tokens de integração, clique nos três pontos ao lado do token desejado. A partir desse menu é possível ativar/desativar o token, editar os IPs permitidos ou removê-lo.

Consigo criar um token de integração que não seja um usuário?

Não, apenas é possível criar tokens de integração para usuários cadastrado.