Pular para o conteúdo principal

Registro de usuário

✅ Propósito do cenário:

  • Obtemos o formulário de registro para gerar o formulário frontend
  • O usuário insere os dados necessários e se registra.
  • Após o registro, o usuário recebe um código de ativação por e-mail/sms
  • O usuário insere o código de ativação e ativa o usuário criado.

✅ O que você precisa:

  • Uma PROJECT_URL e APP_TOKEN válidos para autenticação com a API OneEntry.
  • Formulário de registro com marcador "reg"
  • Campos do formulário (atributos) com marcadores "email_reg", "password_reg", "name_reg", "phone_reg"
  • E-mail/número de telefone válido para receber o código de ativação

📌 Importante:

  • Não tratamos erros nesses exemplos.
  • Você pode tratar erros em trycatch ou em uma construção como "await Promise.catch((error) => error)"

Cenário​

1. Importar oneEntry e definir url e token​

Exemplo:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'sua-url-do-projeto';
const APP_TOKEN = 'seu-token-do-app';

2. Criando um cliente API com a função defineOneEntry()​

Exemplo:

const { Forms, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Obtemos um formulário de registro com Forms.getFormByMarker() para gerar um formulário frontend​

Exemplo:

const form = await Forms.getFormByMarker('reg');
Resultado:
{
  "id": 4,
  "attributeSetId": 5,
  "type": "sing_in_up",
  "localizeInfos": {
    "title": "Registro",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 0,
  "position": 1,
  "identifier": "reg",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "string",
      "marker": "email_reg",
      "isLogin": true,
      "isSignUp": false,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        },
        "emailInspectionValidator": true
      },
      "localizeInfos": {
        "title": "E-mail"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "name_reg",
      "isLogin": null,
      "isSignUp": true,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Nome"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "phone_reg",
      "isLogin": null,
      "isSignUp": true,
      "position": 3,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        }
      },
      "localizeInfos": {
        "title": "Telefone"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "password_reg",
      "isLogin": null,
      "isSignUp": null,
      "position": 4,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {
        "requiredValidator": {
          "strict": true
        },
        "stringInspectionValidator": {
          "stringMax": 0,
          "stringMin": 0,
          "stringLength": 0
        }
      },
      "localizeInfos": {
        "title": "Senha"
      },
      "additionalFields": [],
      "isNotificationEmail": false,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "string",
      "marker": "email_notification_reg",
      "isLogin": null,
      "isSignUp": null,
      "position": 5,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "e-mail para notificação"
      },
      "additionalFields": [],
      "isNotificationEmail": true,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

4. Preparando dados para registro de usuário e registrar usuário com AuthProvider.signUp()​

Dados:

{
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "email_reg",
      "value": "seu-usuario@email.com"
    },
    {
      "marker": "password_reg",
      "value": "123456"
    }
  ],
  "formData": {
    "pt_BR": [
      {
        "marker": "name_reg",
        "type": "string",
        "value": "NomeDeUsuario"
      },
      {
        "marker": "phone_reg",
        "type": "string",
        "value": "+18007986545"
      },
      {
        "marker": "email_notification_reg",
        "type": "string",
        "value": "seu-usuario@email.com"
      }
    ]
  },
  "notificationData": {
    "email": "seu-usuario@email.com",
    "phonePush": [],
    "phoneSMS": "+18007986545"
  },
  "langCode": "pt_BR"
}

Exemplo:

const newUser = await AuthProvider.signUp('email', registrationData);
Resultado:
{
  "identifier": "seu-usuario@email.com",
  "isActive": false,
  "formData": [
    {
      "marker": "name_reg",
      "type": "string",
      "value": "NomeDeUsuario"
    },
    {
      "marker": "phone_reg",
      "type": "string",
      "value": "+18007986545"
    },
    {
      "marker": "email_notification_reg",
      "type": "string",
      "value": "seu-usuario@email.com"
    }
  ],
  "notificationData": {
    "email": "seu-usuario@email.com",
    "phonePush": [],
    "phoneSMS": "+18007986545"
  },
  "locale": "pt_BR",
  "updatedDate": "2025-04-30T20:07:38.156Z",
  "deletedAt": null,
  "id": 33,
  "version": 0,
  "state": {}
}

5. Gerar um código de confirmação com AuthProvider.generateCode() enviado para e-mail/sms​

Dados:

seu-usuario@email.com

Exemplo:

const generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');
Resultado:
{
  "statusCode": 400,
  "timestamp": "2025-04-30T20:07:39.755Z",
  "message": "Usuário já possui um código",
  "pageData": null
}

6. O usuário insere o código → verificação​

Exemplo:

const code = prompt('Digite o código de verificação:') as string;

7. Verificar código com AuthProvider.checkCode() Se o código estiver correto, ative o usuário​

Exemplo:

const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);
if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ Usuário ativado!');
} else {
  console.log('❌ Código de verificação inválido');
}

8. Autenticação do usuário com AuthProvider.auth()​

Exemplo:

const authResponse = await AuthProvider.auth('email', {
  authData,
});
Resultado:
{
  "userIdentifier": "seu-usuario@email.com",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR...pZCI6MTYsImF1dGhQ"
  "refreshToken": "1745494429101-...-2834edf8"
}

Exemplo final​

// 1. Importar oneEntry e definir PROJECT_URL e APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'sua-url-do-projeto';
const APP_TOKEN = 'seu-token-do-app';

const emailReg = 'seu-usuario@email.com';

// 2. Criando um cliente API:
const { Forms, AuthProvider } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Obtemos um formulário de registro com campos personalizados para gerar um formulário frontend
const form = await Forms.getFormByMarker('reg');

// 4. Preparando dados para registro de usuário e registro do usuário
const authData = [
  {
    marker: 'email_reg',
    value: 'seu-usuario@email.com',
  },
  {
    marker: 'password_reg',
    value: '123456',
  },
];
const formData = [
  {
    marker: 'name_reg',
    type: 'string',
    value: 'NomeDeUsuario',
  },
  {
    marker: 'phone_reg',
    type: 'string',
    value: '+18007986545',
  },
  {
    marker: 'email_notification_reg',
    type: 'string',
    value: emailReg,
  },
];
const notificationData = {
  email: emailReg,
  phonePush: [],
  phoneSMS: '+18007986545',
};
const registrationData = {
  formIdentifier: 'reg',
  authData: authData,
  formData: formData,
  notificationData: notificationData,
};
let newUser = await AuthProvider.signUp('email', registrationData);

// 5. Gerar um código de confirmação (enviado para o e-mail)
let generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');

// 6. O usuário insere o código → verificação
const code = prompt('Digite o código de verificação:') as string;

// 7. Ativação do usuário
const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);

if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ Usuário ativado!');
} else {
  console.log('❌ Código de verificação inválido');
}

// 8. Autenticação do usuário
const authResponse = await AuthProvider.auth('email', {
  authData,
});
console.log(authResponse);