Skip to main content

1. apiauth.rule - Autenticação

Esta API é responsável pelo processo de autenticação e fornecimento do token de consumo. Ela fornece token simples com expiração ou JWT.

Dados da requisição

POST /apiauth.rule?sys=ERP HTTP/1.1
Content-Type: application/json

{
  "usuario": "meu_usuario",
  "senha": "minha_senha",
  "acao":"token"
}

Especificação das tags

Tag Descrição
acao Valores possíveis: token

✅ Resposta de Sucesso

{
  "token": "65FB5C03-A316-43FB-859B-9865A2595795",
  "dtexpiracao": "2025-08-25T22:00:00Z"
}

❌ Possíveis Erros

- `400 Bad Request`
  - JSON de parâmetros inválido
  - Dados de login inválidos 
  - Tag "acao" inválida
- `401 Unauthorized` → Credenciais inválidas.
  - Usuário ou senha inválidos
    - Usuário desativado
- `405 Method Not Allowed`
  - Tentativa de acesso ao endpoint com método diferente de POST.  

Uso do Token

O token deve ser utilizado em todas as APIS autenticadas e deve ser informado no cabeçalho Authorization:

Exemplo para requisição com token simples

GET /api.rule?sys=ERP HTTP/1.1
Host: api.exemplo.com
Authorization: Token 65FB5C03-A316-43FB-859B-9865A2595795

Exemplo para requisição com JWT

GET /api.rule?sys=ERP HTTP/1.1
Host: api.exemplo.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Validação do Token

  • O token é validado junto ao servidor.
  • Se válido → requisição é processada.
  • Se inválido ou expirado → retorna 401 Unauthorized.

Observações

  • O token expira automaticamente após o tempo definido.
  • Caso o token expire, é necessário realizar novamente a apiauth para obter um novo.
  • Tokens inválidos são rejeitados com 401 Unauthorized.