Autenticação

A autenticação na API é feita através da informação do token de acesso em todos as requisições feitas.

Toda chamada à API está associada a um user e deve ser feito com o token de acesso deste usuário.

Todos os recursos criados e listados pertencerão a este usuário, ou à user_company associada a este usuário.

Um token de acesso à API pode ser obtido na tela de Configuração da API. O token de acesso não pode ser modificado após gerado. Ele pode apenas ser re-gerado, nesta mesma tela. Ele também pode ser re-gerado via API.

Um retorno HTTP de qualquer chamada à API com status 403 ou 302 Redirect significa que as credenciais não foram aceitas.

O token de acessos à API pode ser passado por qualquer uma das três formas a seguir.

HTTP Bearer

Consiste em passar em todos os requests para API um header HTTP de nome Authorization e valor Bearer <token>. Onde <token> é substituído pelo seu token de acesso à API.

Esta é a forma recomendada de autenticação.

HTTP Basic auth

Equivale a passar ao cliente HTTP que suporte autenticação do tipo Basic, um nome de usuário igual ao seu token de acesso e a senha vazia.

Caso o cliente HTTP não suporte autenticação Basic, na prática consiste em passar no request um header HTTP de nome Authorization e valor Basic <token mais :>. Onde <token mais :> é substituído pelo seu token de acesso à API sufixado pelo caracter :, codificados em base64.

Exemplo, se o token de acesso é 7bdaa8d6-afbd-4d41-84d2-ff60c2568e97, o valor a ser codificado em base64 é: 7bdaa8d6-afbd-4d41-84d2-ff60c2568e97:, que codificado fica N2JkYWE4ZDYtYWZiZC00ZDQxLTg0ZDItZmY2MGMyNTY4ZTk3Og==. Este é o valor a ser passado no header HTTP Authorization.