Acessar artigos

Registro

Rota usada para criar novos usuários no sistema

@Post('authentication/register') {
email: string,
name: string,
password: string,
phone_number: string
}

Exemplo:

{ 
"email": "jomilic588@3dinews.com", 
"name": "Test Register", 
"password": "123456", 
"phone_number": "+12057404135" 
}

Retorno do exemplo:

{
"email": "jomilic588@3dinews.com",
"phoneNumber": "+12057404135",
"name": "Test Register",
"id": "115",
"active": false,
"isRegisteredWithGoogle": false,
"isTwoFactorAuthenticationEnabled": false,
"isEmailConfirmed": false,
"isPhoneNumberConfirmed": false
}

Confirmação de email

Rota usada para confirmar o email do usuário após seu registro:

@Post('confirm-email') {
token: string;
}

Exemplo:

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImpvbWlsaWM1ODhAM2RpbmV3cy5jb20iLCJpYXQiOjE2NTAwNDQzOTUsImV4cCI6MTY1MDA2NTk5NX0.IfmI36F_6mYAcG0s_huy9Fq8tsVa3zSEDWTiSt9jIw8I"
}

Retorno do exemplo:

201 Created
{
	"generatedMaps": [],
	"raw": [],
	"affected": 1
}

Login

Rota usada para acesso de usuários ao sistema

@Post('login'){
email: string,
password: string
}

Exemplo:

{
"email": "yourname@domain.com",
"password": "123456"
}

Retorno do exemplo:

{
"id": "116",
"email": "yourname@domain.com",
"phoneNumber": "+12000000000",
"name": "Test Auth",
"active": true,
"isRegisteredWithGoogle": false,
"isTwoFactorAuthenticationEnabled": false,
"isEmailConfirmed": true,
"isPhoneNumberConfirmed": false,
"stripe_customer_id": null,
"user_language": "pt-BR",
"avatar": null
}
KeyValue TypeDescription
emailstringEmail de cadastro do usuário
phoneNumberstringNúmero de telefone do usuário
namestringNome do usuário
idbooleanIdentificador do usuário
activebooleanUsuário ativo ou não
isRegisteredWithGooglebooleanUsuário criado por integração com google
IsTwoFactorAuthenticationEnabledbooleanVerifica se há autenticação em dois fatores ativa para este usuário
isEmailConfirmedbooleanVerifica se o email já foi confirmado
isPhoneNumberConfirmedbooleanVerifica se o telefone já foi confirmado
stripe_customer_idstringIdentificação do usuário para o sistema de cobrança
user_languagestringLinguagem escolhida pelo usuário
avatarstringUrl da imagem do avatar do usuário

Verificação de Telefone

Rotas usadas confirmar telefone válido de um usuário

@Post('sms/initiate-verification') /*contendo os cookies de autenticação e refresh -> inicia o processo enviando o código de confirmação via sms para o número registrado do usuário*/
@Post('sms/check-verification-code') /* contendo os cookies de autenticação e refresh + */ {
code: string
}

Exemplo:

{
"code" : "809678"
}

Retorno:

201 created
crosslistmenu-circle