Перейти к основному контенту

Регистрация пользователя

✅ Цель сценария:

  • Мы получаем форму регистрации для генерации фронтенд-формы
  • Пользователь вводит необходимые данные и регистрируется.
  • После регистрации пользователь получает код активации по электронной почте/СМС
  • Пользователь вводит код активации и активирует созданного пользователя.

✅ Что вам нужно:

  • Действительный PROJECT_URL и APP_TOKEN для аутентификации с API OneEntry.
  • Форма регистрации с маркером "reg"
  • Поля формы (атрибуты) с маркерами "email_reg", "password_reg", "name_reg", "phone_reg"
  • Действительный адрес электронной почты/номер телефона для получения кода активации

📌 Важно:

  • Мы не обрабатываем ошибки в этих примерах.
  • Вы можете обрабатывать ошибки в конструкции trycatch или в конструкции типа "await Promise.catch((error) => error)"

Сценарий​

1. Импортируем oneEntry и определяем url и токен​

Пример:

import { defineOneEntry } from 'oneentry';

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

2. Создание API-клиента с помощью функции defineOneEntry()​

Пример:

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

3. Получаем форму регистрации с помощью Forms.getFormByMarker() для генерации фронтенд-формы​

Пример:

const form = await Forms.getFormByMarker('reg');
Результат:
{
  "id": 4,
  "attributeSetId": 5,
  "type": "sing_in_up",
  "localizeInfos": {
    "title": "Регистрация",
    "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": "Электронная почта"
      },
      "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": "Имя"
      },
      "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": "Телефон"
      },
      "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": "Пароль"
      },
      "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": "электронная почта для уведомления"
      },
      "additionalFields": [],
      "isNotificationEmail": true,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

4. Подготовка данных для регистрации пользователя и регистрация пользователя с помощью AuthProvider.signUp()​

Данные:

{
  "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"
}

Пример:

const newUser = await AuthProvider.signUp('email', registrationData);
Результат:
{
  "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. Генерация кода подтверждения с помощью AuthProvider.generateCode() и отправка на электронную почту/СМС​

Данные:

your-user@email.com

Пример:

const generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');
Результат:
{
  "statusCode": 400,
  "timestamp": "2025-04-30T20:07:39.755Z",
  "message": "Пользователь уже имеет код",
  "pageData": null
}

6. Пользователь вводит код → проверка​

Пример:

const code = prompt('Введите код подтверждения:') as string;

7. Проверка кода с помощью AuthProvider.checkCode() Если код верный, активировать пользователя​

Пример:

const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);
if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ Пользователь активирован!');
} else {
  console.log('❌ Неверный код подтверждения');
}

8. Аутентификация пользователя с помощью AuthProvider.auth()​

Пример:

const authResponse = await AuthProvider.auth('email', {
  authData,
});
Результат:
{
  "userIdentifier": "your-user@email.com",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR...pZCI6MTYsImF1dGhQ"
  "refreshToken": "1745494429101-...-2834edf8"
}

Финальный пример​

// 1. Импортируем oneEntry и определяем PROJECT_URL и 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. Создание API-клиента:
const { Forms, AuthProvider } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Получаем форму регистрации с пользовательскими полями для генерации фронтенд-формы
const form = await Forms.getFormByMarker('reg');

// 4. Подготовка данных для регистрации пользователя и регистрация пользователя
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. Генерация кода подтверждения (отправка на электронную почту)
let generateCode = await AuthProvider.generateCode('email', emailReg, 'auth');

// 6. Пользователь вводит код → проверка
const code = prompt('Введите код подтверждения:') as string;

// 7. Активация пользователя
const isCorrect = await AuthProvider.checkCode(
  'email',
  emailReg,
  '1',
  code,
);

if (isCorrect) {
  await AuthProvider.activateUser('email', emailReg, code);
  console.log('✅ Пользователь активирован!');
} else {
  console.log('❌ Неверный код подтверждения');
}

// 8. Аутентификация пользователя
const authResponse = await AuthProvider.auth('email', {
  authData,
});
console.log(authResponse);