Autenticação

Tipo de autenticação

A autenticação na WebRota é feita através da utilização de uma chave de API. Esta chave serve para que o sistema identifique a sua conta e conceda permissões para que o sistema se comunique com a iugu em nome da conta em questão.

Para tanto utilizaremos a autenticação Bearer Authentication.

Gerando um token via API

Nossa API REST foi projetada para fornecer um mecanismo seguro de autenticação utilizando tokens JWT (JSON Web Tokens). Essa abordagem permite que você integre facilmente a autenticação em seu aplicativo e proteja seus endpoints de forma eficaz.

Ao fazer uma solicitação de autenticação, você fornecerá suas credenciais (como nome de usuário e senha) para o endpoint específico. Em resposta, nossa API irá autenticar suas informações e, se válidas, gerará um token JWT exclusivo.

POST

https://api.webrota.com.br/auth/login/

Parâmetros de entrada:

{ 
    "username": "api-user", 
    "parent_username": "CNPJ DA EMPRESA" 
    "password": "?", 
    "realm": "F", 
} 

Exemplo de Resposta do servidor:

{ 
    "access_token": "Token que deve ser utilizado nas próximas requisições através do cabeçalho authorization", 
    "refresh_token": "token que deve ser armazenado para renovar o token de acesso", 
    "user": {...} 
} 

Renovação de token de acesso

Um Refresh Token é um token adicional com uma duração de validade maior, que é retornado junto com o token JWT inicial.

Quando o token JWT expira, você pode usar o Refresh Token para solicitar um novo token JWT sem a necessidade de fornecer suas credenciais novamente. Esse fluxo reduz a exposição de informações sensíveis e melhora a experiência do usuário ao evitar a necessidade de fazer login repetidamente.

Para renovar o token JWT usando o Refresh Token, você precisará fazer uma solicitação para o endpoint de atualização de token, fornecendo o Refresh Token válido. Em resposta, você receberá um novo token JWT e um novo Refresh Token, que podem ser usados para autenticação contínua.

Não é necessário enviar nenhum payload nesse endpoint.

POST

https://api.webrota.com.br/auth/token/

Exemplo de Resposta do servidor:

{ 
    "access_token": "Novo token de acesso", 
    "user": {...} 
}