POST Autenticação - Obtendo token
Introdução
A rota permite a autenticação de usuários e retorna um token do tipo bearer, que deve ser utilizado nas demais requisições à API para garantir a segurança e a autenticidade do acesso.
Rota
/Usuario/login
Authorization
É necessário um token de autorização do tipo Bearer Token. O token deve ser fornecido da seguinte forma:
Token | eyJhbGc... |
Headers Request
Accept |
application/json |
Content-Type |
application/json |
Detalhes da API
Campos obrigatórios e seus respectivos tipos
Campos Obrigatórios
Campo | Tipo | Descrição |
login |
string | Nome de usuário ou identificação única utilizada para autenticação no sistema. |
senha |
string | Senha de acesso do usuário, utilizada para garantir a segurança durante o processo de autenticação. |
apiKey |
string | Chave de acesso à API, necessária para autenticar requisições e garantir que o usuário tenha permissão para acessar os recursos da aplicação. |
Campos Opcionais
Campo | Tipo | Descrição |
Nenhum | - | Não existem campos opcionais. |
Exemplo de Requisição e Resposta
Exemplo de Request
curl
curl --location 'https://app2-crefaz-api-external-stag.azurewebsites.net/api/Usuario/login' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"login": "CC00000000",
"senha": "senha",
"apiKey": "api-key-0000-0000-0000"
}
'
Body da Requisição
body
{
"login": "CC00000000",
"senha": "senha",
"apiKey": "api-key-0000-0000-0000"
}
Exemplo de Response
json
{
"success": true,
"data": {
"userId": 1000,
"login": "CC00000000",
"token": "eyJ...",
"expires": "2024-10-05T05:41:47.2189101Z",
"refreshToken": null,
"nome": "NOME DO USUARIO AUTENTICADO",
"telefonia": "Dígitro"
},
"errors": null
}
Headers de Response (7)
Content-Type |
application/json; charset=utf-8 |
Exemplo de Resposta (200 OK)
Caso falhe a autenticação, a resposta conterá uma mensagem de erro indicando o problema encontrado.
No Comments