Pular para o conteúdo principal

API de Login

A API de Login é responsável pela autenticação de usuários no sistema Accessus. Através dela, você obtém o token necessário para acessar todos os outros endpoints protegidos da API.

Usuário API

Apenas usuários marcados como API no sistema podem autenticar-se por este endpoint. Usuários comuns (não-API) receberão 401 UNAUTHORIZED.

Visão Geral

MétodoEndpointDescrição
POST/users/loginObter token de autenticação
Base URL

Todos os endpoints utilizam o prefixo: /accessus/api/v1


Autenticação

Obter Token de Autenticação

Realiza o login no sistema e retorna um token de autenticação que deve ser utilizado em todas as requisições subsequentes.

POST/accessus/api/v1/users/login

Autenticação

RequisitoValor
AutenticaçãoNão requerida
Content-Typeapplication/json

Corpo da Requisição

CampoTipoObrigatórioDescrição
usernamestringNome de usuário do sistema
passwordstringSenha do usuário

Exemplo de Requisição:

{
"username": "joao.silva",
"password": "abcd1234"
}

Respostas

200 OK - Login realizado com sucesso

O token de autenticação é retornado no header da resposta:

HeaderDescrição
X-AUTH-TOKENToken de autenticação para uso nas demais requisições

Exemplo de Header:

X-AUTH-TOKEN: 93144b288eb1fdccbe46d6fc0f241a51766ecd3d=
401 UNAUTHORIZED - Credenciais inválidas

Usuário ou senha incorretos.


Como Usar o Token

Após obter o token, inclua-o no header de todas as requisições às APIs protegidas:

X-AUTH-TOKEN: seu_token_aqui

Exemplo com cURL:

curl -X GET "https://seu-dominio.com/accessus/api/v1/accesses/expired" \
-H "X-AUTH-TOKEN: 93144b288eb1fdccbe46d6fc0f241a51766ecd3d="
Segurança
  • Mantenha seu token em segurança e nunca o exponha em código público
  • O token tem validade limitada; renove-o quando necessário
  • Não compartilhe suas credenciais de acesso