🔐Autenticação do Estabelecimento Comercial para Transações

Endpoint para realizar a autenticação de estabelecimentos comerciais na plataforma.

Uma vez autenticado, o estabelecimento poderá iniciar transações e acessar os serviços da API. O Access Token obtido deverá ser incluído no cabeçalho de autenticação de todas as futuras requisições.

Autenticar o estabelecimento comercial

post

Endpoint para autenticar o estabelecimento e permitir que sejam criadas transações. Ao autenticar, guardar o AccessToken (result.AuthenticationResult.AccessToken) retornado para fazer as outras requisições. Para renovar o token, utilize o endpoint /auth/refresh-token passando o RefreshToken.

Body

usernamestringOptional

Email do usuário

passwordstringOptional

Senha do usuário

Responses

200

Sucesso na autenticação

401

Falha na autenticação

post

HTTPcURLJavaScriptPython

POST /auth HTTP/1.1
Host: gws.bemfacil.com.br
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "username": "[e-mail]",
  "password": "123456"
}

No content

Após uma autenticação bem-sucedida, a API retornará um JSON com o Access Token e outros detalhes relevantes, como o tipo de token e o tempo de expiração.

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkVzdGFiZWxlY2ltZW50byIsImlhdCI6MTUxNjIzOTAyMn0.QKVwRQK_f3t3edKvKCTHKtY5VJGmOgaT_r3jC6YAyTI",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "9c0e1d9dbcf447a8a8e9064bc18a4a0b"
}

---

Alteração de Senha do Usuário Autenticado

Este endpoint é destinado a permitir que usuários autenticados atualizem sua senha. É uma operação crítica de segurança que garante que os usuários possam manter o controle de acesso às suas contas na plataforma.

Altera a senha do usuário logado

put

Endpoint para alterar a senha do usuário autenticado

Body

new_passwordstringOptional

Nova senha para ser definida

Responses

200

Sucesso na alteração

401

Falha na alteração de senha

put

HTTPcURLJavaScriptPython

PUT /auth/change-password HTTP/1.1
Host: gws.bemfacil.com.br
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "new_password": "123456"
}

No content

Respostas Esperadas:

• 200 OK: Indica que a senha foi alterada com sucesso. O usuário deverá usar a nova senha em todas as próximas autenticações.

• 401 Unauthorized: Significa que a requisição de alteração de senha falhou, o que pode ocorrer se o token de acesso não for válido ou a sessão do usuário tiver expirado.

Notas de Segurança:

• As senhas devem seguir um padrão forte de complexidade, combinando letras maiúsculas e minúsculas, números e símbolos.

• É recomendável que o usuário seja desconectado de todas as sessões após a alteração da senha, por motivos de segurança.

• As senhas nunca devem ser transmitidas ou armazenadas em texto puro. Certifique-se de que sua aplicação esteja usando HTTPS e métodos de criptografia adequados.

Dicas de UX:

• Forneça feedback imediato ao usuário após a tentativa de alteração de senha.

• Em caso de erro, dê instruções claras sobre como proceder ou onde obter ajuda.

---

Atualização de Token de Acesso Expirado

Este endpoint é projetado para atualizar tokens de acesso que expiraram. O objetivo é garantir que os usuários permaneçam autenticados sem a necessidade de inserir suas credenciais novamente, proporcionando uma experiência de usuário contínua e segura.

Funcionalidade: Para continuar a sessão do usuário sem interrupção, este endpoint aceita um Refresh Token válido e retorna um novo Access Token. Este processo permite que as sessões dos usuários sejam estendidas de maneira segura.

Requisitos: Os usuários devem já possuir um Refresh Token válido, que é obtido durante o processo de autenticação inicial.

Atualizar o token expirado

post

Só passar o refreshToken obtido na autenticação

Body

tokenstringOptional

Refresh token obtivo

Responses

200

Sucesso na autenticação

401

Falha na autenticação

post

HTTPcURLJavaScriptPython

POST /auth/refresh-token HTTP/1.1
Host: gws.bemfacil.com.br
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "token": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIi"
}

No content

Respostas Esperadas:

• 200 OK: A resposta indica que o Refresh Token foi aceito e um novo Access Token foi gerado com sucesso.

• 401 Unauthorized: Esta resposta significa que houve falha na autenticação, possivelmente devido a um Refresh Token inválido ou expirado.

Boas Práticas:

• O Refresh Token deve ser armazenado de maneira segura, evitando vazamento de informações sensíveis.

• A renovação do token deve ser feita antes do Access Token expirar para manter a sessão do usuário ativa.

• Encoraje os usuários a saírem de todas as sessões ativas se suspeitarem que sua segurança foi comprometida.

---