Pular para o conteúdo principal

Autenticação de Usuário

POST /signin

HTTP
POST /signin HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json

Endpoint para autenticação de usuários do ecommerce. Retorna um token JWT para acesso aos recursos protegidos da API.

Atributos para autenticação

CampoTipoDescriçãoObrigatório
emailstringEmail do usuário cadastrado no sistema.
passwordstringSenha do usuário.
aplicacaostringAplicação de origem, valores válidos são "ECOMMERCE", "PARCEIRO" ou "BACKOFFICE".

Requisição

Body
{
"email": "ronaldo.mota@vileve.com.br",
"password": "senha",
"aplicacao": "ECOMMERCE"
}

Resposta

200
{
"status": "success",
"message": "Logado com sucesso",
"user": "juliana.mota@vileve.com.br",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZyZXNoVG9rZW4iOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKMWMyVnlJam9pYW5Wc2FXRnVZUzV0YjNSaFFIWnBiR1YyWlM1amIyMHVZbklpTENKaGNIQnNhV05oZEdsdmJpSTZJa1ZEVDAxTlJWSkRSU0lzSW1saGRDSTZNVGMxTlRZek1EYzBNeXdpWlhod0lqb3hOelUxTmpNM09UUXpmUS5vOEFJcmtWSDNUblY3RmRJekkxMTdBaFR1Mm15Z3hnQlVmR3J3QVlDUDhRIiwidXNlciI6Imp1bGlhbmEubW90YUB2aWxldmUuY29tLmJyIiwiYXBwbGljYXRpb24iOiJFQ09NTUVSQ0UiLCJpYXQiOjE3NTU2MzA3NDMsImV4cCI6MTc1NTYzNDM0M30.6sFg4WZyOhNTvLtUX9PeL4EeMVGkphZJoHi9Ts-C64w",
"currentRefreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoianVsaWFuYS5tb3RhQHZpbGV2ZS5jb20uYnIiLCJhcHBsaWNhdGlvbiI6IkVDT01NRVJDRSIsImlhdCI6MTc1NTYzMDc0MywiZXhwIjoxNzU1NjM3OTQzfQ.o8AIrkVH3TnV7FdIzI117AhTu2mygxgBUfGrwAYCP8Q"
}

Resposta de Sucesso

CampoTipoDescriçãoObrigatório
statusstringStatus da operação, sempre "success" em caso de sucesso.
messagestringMensagem de confirmação do login.
userstringEmail do usuário autenticado.
tokenstringToken JWT de acesso para autenticação nas próximas requisições. Válido por 1 hora.
currentRefreshTokenstringToken de refresh para renovar o token de acesso. Válido por 2 horas.

Errors

CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Campos obrigatórios ausentes ou inválidos.
401UNAUTHORIZEDCredenciais inválidas. Email ou senha incorretos.
403FORBIDDENUsuário não possui permissão para acessar a aplicação especificada.
404NOT FOUNDUsuário não encontrado no sistema.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição. Dados mal formatados.
500INTERNAL SERVER ERRORErro interno do servidor.

Uso do Token

Após a autenticação bem-sucedida, use o token retornado no header Authorization das próximas requisições:

Exemplo de uso
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Renovação do Token

Quando o token de acesso expirar, use o currentRefreshToken para obter um novo token sem precisar fazer login novamente.

Aplicações Suportadas

  • ECOMMERCE: Portal de vendas online
  • PARCEIRO: Sistema de parceiros
  • BACKOFFICE: Sistema administrativo interno