Autenticação
A API utiliza autenticação através de uma chave de API (apiKey) e credenciais do usuário (login e senha). A apiKey é um requisito fundamental para garantir a segurança das operações e deve ser solicitada ao Supervisor ou Gerente Comercial da empresa. Após a solicitação, a apiKey será entregue em até 3 dias úteis.

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. 

 Caso o usuário erre a senha 3 vezes, seu acesso será bloqueado. Para desbloqueio, deverá solicitar ao departamento de credenciamento. 

 

 

 

 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 

 

 

 

 Campo 

 Tipo 

 Obrigatório 

 Descrição 

 

 

 

 

 login 

 string 

 Sim 

 Nome de usuário ou identificação única utilizada para autenticação no sistema. 

 

 

 senha 

 string 

 Sim 

 Senha de acesso do usuário, utilizada para garantir a segurança durante o processo de autenticação. 

 

 

 apiKey 

 string 

 Sim 

 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 

 

 sucesso 

 {

 "success": true,

 "data": {

 "userId": 1000,

 "login": "CC00000000",

 "token": "eyJ...",

 "expires": "2024-10-05T05:41:47.2189101Z",

 "refreshToken": null,

 "nome": "NOME DO USUARIO AUTENTICADO",

 "telefonia": null,

 "senhaExpirada": null

 },

 "errors": null

} 

 

 

 erro 

 {

 "success": false,

 "data": null,

 "errors": [

 "ApiKey não corresponde",

 "Usuário não encontrado"

 ]

} 

 

 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. 

 

 Possíveis Erros 

 

 

 401 Unauthorized : Login, senha ou apiKey incorretos. 

 

 

 400 Bad Request : Algum dos campos obrigatórios está ausente ou com formato inválido. 

 

 

 

 Tela Referência - CrefazOn