Usuário

O contexto de usuários terão métodos para consulta de informações a ações referentes aos usuários do sistema.

Recursos de usuário

Ação	Descrição
/user.validateEmail	Envia um código de validação por e-mail
/user.validateEmailCode	Confirma o código recebido por e-mail
/user.validateMobile	Envia um código de validação por sms
/user.validateMobileCode	Confirma o código recebido por sms
/user.register	Cadastra um usuário no sistema
/user.login	Gera um token de acesso para o usuário
/user.logout	Encerra a sessão do token atual
/user.recovery	Recupera acesso de uma conta
/user.ChangePassword	Permite definir uma nova senha. Pós recovery
/user.profile	Exibe informações do usuário
/user.updateProfile	Atualiza perfil do usuário ❗
/user.removePhoto	Remove foto do perfil ❗
/user.updatePhoto	Atualiza foto de perfil ❗
/user.rules	Lista regras que o usuário possui no sistema

Cadastra um usuário no sistema

POST https://api.peoplepass.com.br/user.register

Request Body

Name	Type	Description
gender	string	Gênero (M ou F)
birthday	string	Data de nascimento (YYYY-MM-DD)
password	string	Senha escolhida
email	string	Endereço de e-mail
name	string	Nome completo

200 Usuário registrado com sucesso.

{
    "id": 1876543210,
    "name": "Bruce Wayne",
    "email": "[e-mail]",
    "gender": "m",
    "birthday": "1940-12-01"
}

400 Exemplo de erro

{
    "errors": ["E-mail obrigatório","Data de nascimento inválida"]
}

Confirma e-mail do usuário

POST https://api.peoplepass.com.br/user.confirmEmail

Request Body

Name	Type	Description
code	string	Código enviado por e-mail

200

Obter token com login e senha do usuário

POST https://api.peoplepass.com.br/user.login

Recebe um token que expira até a próxima 7h da manhã, ou até o logout, que revoga o token.

Request Body

Name	Type	Description
user	string	e-mail do usuário
password	string	senha do usuário

200 Exemplo de sucesso

{
    "token" : "1234-1234-1234-1234"
    "id" : 187654321
    "name" : "Bruce Wayne"
    "expire" : 1564165800
}

401 Exemplo de erro

{
    "errors" : ["Senha obrigatória","Login inválido"]
}

Logout de usuário

POST https://api.peoplepass.com.br/user.logout

Revoga o token de usuário

Headers

Name	Type	Description
Authorization: Basic	string	Token de usuário

200

{
    'success' : 'Logout efetuado com sucesso'
}

Recuperação de conta

POST https://api.peoplepass.com.br/user.recovery

Recuperação de conta, caso o usuário seja localizado, envia um link por e-mail do usuário que dá acesso para que ele possa definir uma nova senha. Endpoint para definir nova senha: /user.changePassword

Request Body

Name	Type	Description
email	string	E-mail de cadastro do usuário
mobile_country	string	Código de País do celular
mobile	string	Número do celular
document_cpf	string	CPF - Número de documento
birthday	string	Data Nascimento (DD/MM/YYY)

200

{
    'success' : 'Siga as instruções enviada por e-mail'
}

POST https://api.peoplepass.com.br/user.recovery

Request Body

Name	Type	Description
document_cpf	string	CPF

200

 {"success":true}

POST https://api.peoplepass.com.br/user.changePassword

Request Body

Name	Type	Description
password	string
recovery_code	string

200

{"success":true}

Obter perfil do usuário

POST https://api.peoplepass.com.br/user.profile

Retorna o perfil do usuário

Headers

Name	Type	Description
Authorization: Basic	string	Token de usuário

200

{
    "id":19438545951,
    "name":"Bruce Wayne",
    "gender":"m",
    "birthday":"1940-12-01",
    "email": "[e-mail]",
    "user":"[e-mail]"
}

Trocar senha do usuário

POST https://api.peoplepass.com.br/v1/user.updatePassword

Request Body

Name	Type	Description
new_password	string	A nova senha do usuário
password	string	A senha atual do usuário

200