Endpoint de Autenticação
Método: POST /Login
URL de Produção: https://api.bahn.nordware.io/v1/Login
URL de Stage: https://api.stage.bahn.nordware.io/v1/Login
Descrição:
O Endpoint de autenticação permite a obtenção de um token de acesso (Bearer Token), que será utilizado para autorizar e autenticar os demais pedidos à API. Este token é válido por um período determinado e deve ser incluído no cabeçalho de autorização de cada solicitação subsequente.
Parâmetros de Requisição:
Parâmetro |
Tipo |
Descrição |
---|---|---|
|
String |
Nome de usuário associado à conta do usuário. |
|
String |
Senha associada à conta do usuário. |
POST | https://api.stage.bahn.nordware.io/v1/Login |
---|---|
Request Body { "userName": "teste@bahn.io", "password": "Teste@587" } |
Exemplo de Corpo da Requisição:
Respostas:
- Código 200 (OK): A solicitação foi bem-sucedida. O corpo da resposta conterá o token de acesso.
{ "name": "teste@teste.com", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkRlbmdvLUNob2NvbGF0ZXMiLCJyb2xlIjoiVXNlciIsIm5iZiI6MTY0MzgwNzk2OSwiZXhwIjoxNjQzODE4NzY5LCJpYXQiOjE2NDM4MDc5Njl9.UgZ1RlpE878LKvWriF9FDkO2Rh7zIau-kQb8kglZ7II" }
-
-
token
: Token de acesso que deve ser incluído nos cabeçalhos das solicitações subsequentes.
-
-
-
token_type
: Tipo de token, que neste caso é "Bearer".
-
- Código 401 (Não Autorizado): A autenticação falhou devido a credenciais inválidas.
{ "message": "Usuario ou senha inválida." }
Exemplo de Uso:
- Obtenção do Token:
-
- Envie uma solicitação POST para
https://api.bahn.nordware.io/v1/Login
incluindo as credenciais no corpo da solicitação. - Receba o token de acesso no corpo da resposta.
- Envie uma solicitação POST para
- Uso do Token:
-
- Inclua o token de acesso no cabeçalho de autorização de todas as solicitações subsequentes como
Bearer seu_bearer_token.
- Inclua o token de acesso no cabeçalho de autorização de todas as solicitações subsequentes como
Observações:
-
- Mantenha o token de acesso em local seguro, evitando compartilhá-lo publicamente.
- Renove o token conforme necessário, reenviando as credenciais para o endpoint de autenticação. O token expirará após 3 horas.
Este artigo possui continuação, clique aqui para acessar a parte 2.