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:

Headers Request

Campos Obrigatórios:

• login (string): Nome de usuário ou identificador exclusivo do usuário.

• senha (string): Senha do usuário.

• apiKey (string): Chave da API, necessária para realizar a autenticação.

Campos Opcionais:

• Nenhum.

Exemplo de Requisição e Resposta

Exemplo de Request

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

{
  "login": "CC00000000",
  "senha": "senha",
  "apiKey": "api-key-0000-0000-0000"
}

Exemplo de Response

{
  "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)

Resposta Esperada

Caso a autenticação seja realizada com sucesso, a API retornará um objeto contendo o token de autenticação (bearer). Esse token deve ser usado nos headers de outras chamadas às rotas da API, no formato:

• Authorization: Bearer {token}

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