Pular para o conteúdo

Realizar login

POST /api/auth/v1/login

O que este endpoint faz

Este endpoint autentica o usuário e inicia uma sessão de API para consumo autenticado dos recursos protegidos. Ele pertence ao domínio de autenticação, sessão e identificação do usuário que consome a plataforma.

Use POST /api/auth/v1/login quando a integração precisar acionar esse comportamento exatamente como o app da Antecipa Fácil faz pelo gateway público.

Para que serve

Ele ajuda a compor fluxos de integração do backend do parceiro com a plataforma, mantendo autenticação via Bearer token e tráfego pelo APIM. Consulte os parâmetros, corpo de requisição e respostas desta página antes de usar em produção.

Parâmetros

Este endpoint não declara parâmetros adicionais na especificação OpenAPI.

Corpo da requisição

Envie o payload em JSON conforme o contrato do backend.

{
  "username": "<username>",
  "password": "********"
}

Respostas

201 Operação executada com sucesso.