Saltar al contenido principal

Registro de usuario

✅ Propósito del escenario:

  • Obtenemos el formulario de registro para generar el formulario frontend.
  • El usuario ingresa los datos requeridos y se registra.
  • Después del registro, el usuario recibe un código de activación por correo electrónico/sms.
  • El usuario ingresa el código de activación y activa al usuario creado.

✅ Lo que necesitas:

  • Una PROJECT_URL y APP_TOKEN válidos para la autenticación con la API de OneEntry.
  • Formulario de registro con marcador "reg".
  • Campos del formulario (atributos) con marcadores "email_reg", "password_reg", "name_reg", "phone_reg".
  • Correo electrónico/número de teléfono válido para recibir el código de activación.

📌 Importante:

  • No manejamos errores en estos ejemplos.
  • Puedes manejar errores en trycatch o en una construcción como "await Promise.catch((error) => error)".

Escenario​

1. Importar oneEntry y definir url y token​

Ejemplo:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Crear un cliente API con la función defineOneEntry()​

Ejemplo:

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

3. Obtenemos un formulario de registro con Forms.getFormByMarker() para generar un formulario frontend​

Ejemplo:

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": "Correo electrónico"
      },
      "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": "Nombre"
      },
      "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": "Teléfono"
      },
      "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": "Contraseña"
      },
      "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": "correo para notificación"
      },
      "additionalFields": [],
      "isNotificationEmail": true,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

4. Preparar datos para el registro de usuario y registrar usuario con AuthProvider.signUp()​

Datos:

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

Ejemplo:

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

5. Generar un código de confirmación con AuthProvider.generateCode() enviado a correo/sms​

Datos:

your-user@email.com

Ejemplo:

const generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');
Resultado:
{
  "statusCode": 400,
  "timestamp": "2025-04-30T20:07:39.755Z",
  "message": "El usuario ya tiene un código",
  "pageData": null
}

6. El usuario ingresa el código → verificación​

Ejemplo:

const code = prompt('Ingrese el código de verificación:') as string;

7. Verificar el código con AuthProvider.checkCode() Si el código es correcto, activar al usuario​

Ejemplo:

const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);
if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ ¡Usuario activado!');
} else {
  console.log('❌ Código de verificación inválido');
}

8. Autenticación del usuario con AuthProvider.auth()​

Ejemplo:

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

Ejemplo final​

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

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

const emailReg = 'your-user@email.com';

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

// 3. Obtenemos un formulario de registro con campos personalizados para generar un formulario frontend
const form = await Forms.getFormByMarker('reg');

// 4. Preparar datos para el registro de usuario y registro de usuario
const authData = [
  {
    marker: 'email_reg',
    value: 'your-user@email.com',
  },
  {
    marker: 'password_reg',
    value: '123456',
  },
];
const formData = [
  {
    marker: 'name_reg',
    type: 'string',
    value: 'UserName',
  },
  {
    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. Generar un código de confirmación (enviado a correo)
let generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');

// 6. El usuario ingresa el código → verificación
const code = prompt('Ingrese el código de verificación:') as string;

// 7. Activación del usuario
const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);

if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ ¡Usuario activado!');
} else {
  console.log('❌ Código de verificación inválido');
}

// 8. Autenticación del usuario
const authResponse = await AuthProvider.auth('email', {
  authData,
});
console.log(authResponse);