Autenticação
Resumo
Após um usuário de empresa ter recebido seus dados, será necessário se autenticar nessa API para receber as credenciais que será utilizada daqui para frente. Ela irá carregar as permissões de acesso e informações básicas do usuário.
Endpoints
/Auth
Autenticação com login e senha
POST https://goblockchain.io/gotokens-api/v1/auth
Rota que retorna o token JWT de acesso do usuário ao sistema, assim como dados básicos e segundos restantes até a expiração do token.
Request Body
email*
String
E-mail do Usuário
password*
String
Senha do Usuário
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"email": "[email protected]",
"id": "785",
"status": "active",
"secsToExpire": "8599"
}accessToken- StringJWT de uso para acessp e permissionamento ao sistema.
email- StringE-mail do usuário logado.
id- StringIdentificador único do usuário logado.
status- StringStatus do acesso do usuário. Em caso da necessidade do bloqueio de acesso de um usuário, seu status deverá ser mudado para
disabled. Caso contrário, seu status é salvo comoactive.secsToExpire- StringNúmero de segundos resté a necessidade de renovação do
access_tokenpor meio de um novo login.
1
Endereço de e-mail não corresponde à nenhum usuário na base.
10
Senha inserida está incorreta.
1001
Parâmetro "email" inválido. O campo é obrigatório, deve ser do tipo String e seguir um formato de e-mail válido.
1002
Parâmetro "password" inválido. O campo é obrigatório e deve ser do tipo String.
Autenticação com meios externos
POST https://goblockchain.io/gotokens-api/v1/auth/external
Rota que retorna o token JWT de acesso do usuário ao sistema, assim como dados básicos e segundos restantes até a expiração do token.
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"id": "785",
"status": "active",
"secsToExpire": "8599"
}accessToken- StringJWT de uso para acessp e permissionamento ao sistema.
id- StringIdentificador único do usuário logado.
status- StringStatus do acesso do usuário. Em caso da necessidade do bloqueio de acesso de um usuário, seu status deverá ser mudado para
disabled. Caso contrário, seu status é salvo comoactive.secsToExpire- StringNúmero de segundos resté a necessidade de renovação do
access_tokenpor meio de um novo login.
1
Endereço de e-mail não corresponde à nenhum usuário na base.
10
Senha inserida está incorreta.
1001
Parâmetro "email" inválido. O campo é obrigatório, deve ser do tipo String e seguir um formato de e-mail válido.
1002
Parâmetro "password" inválido. O campo é obrigatório e deve ser do tipo String.
/Password-Reset
Redefinição de Senha
POST https://goblockchain.io/gotokens-api/v1/password-reset
Rota que envia um email com um link temporário para redefinição de senha.
Request Body
email*
String
E-mail do Usuário
{
"emailSent": true,
"errorMessage": null
}emailSent- BooleanValida se o e-mail com link para redefinição de senha foi enviado com sucesso
errorMessage- DateTimeRetorna a mensagem de erro caso haja falha no envio do e-mail de redefinição de senha.
1
Endereço de e-mail não corresponde à nenhum usuário na base.
1001
Parâmetro "email" inválido. O campo é obrigatório, deve ser do tipo String e seguir um formato de e-mail válido.
Redefinição de Senha
POST https://goblockchain.io/gotokens-api/v1/password-reset/:reset_token
Rota que redefine a senha do usuário que a requisitou.
Path Parameters
reset_token
String
Token de redefinição de senha enviado por email
Request Body
password*
String
Nova senha do Usuário
{
"passwordChanged": true,
"errorMessage": null
}passwordChanged- BooleanValida se a senha do usuário foi alterada com sucesso.
errorMessage- DateTimeRetorna a mensagem de erro caso haja falha na redefinição de senha do usuário.
1
Token de redefinição de senha inexistente na base de dados.
1001
Parâmetro "password" inválido. O campo é obrigatório, deve ser do tipo String.
Last updated
Was this helpful?