Skip to main content

Autenticação (Auth)

A maioria das requisições feitas para a API precisam ser autenticadas com algum usuário, sendo ele normal ou de integração. Dessa forma é possível determinar quais operações sobre quais recursos esse usuário tem acesso.

Recomendamos que cada desenvolvedor tenha um usuário próprio para melhor gerenciar Webhooks e outras configurações. As rotas relacionadas a autenticação são subrotas de /auth.

Códigos de erro​

  • 401 Unauthorized: O servidor não conseguiu autenticar a requisição.
  • 403 Permission Denied: O servidor conseguiu autenticar a requisição porém o usuário não ter permissão para acessar aquele recurso ou executar aquela ação.

Usuário e senha​

Para iniciar, crie um usuário pela rota /auth/users/. Em seguida, acesse o seu e-mail e clique no link de ativação. Agora é possível fazer login pelo Browser e ter acesso as rotas pelo Browsable API.

Token​

Para acessar os recursos da API pelo código utilize um token de autenticação. Esses tokens são vitalicios, sendo assim, não expiram.

Disponibilizamos a rota /auth/token/login/ para criar/resgatar o token do seu usuário.

Para autenticar a requisição crie um Header chamado Authorization com valor Token {o seu token vai aqui}. 

Authorization: Token 36434d218c36630f668af3dc089aea78ff63b98c

Caso veja necessidade de excluir o seu token, acesse a rota /auth/token/logout/ com usuário logado e clique em POST.

JWT

A API também possibilita autenticar as requisições utilizando Json Web Token. Recomendamos utilizar o token vitalicio por mais praticidade.