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

Отправка формы

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

  • Получить конфигурацию формы из OneEntry CMS
  • Собрать данные, введенные пользователем, из контактной формы.
  • Убедиться, что данные правильно отформатированы и проверены перед отправкой.
  • Отправить собранные данные в API OneEntry.

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

  • Действительный PROJECT_URL и APP_TOKEN для аутентификации с API OneEntry.
  • Предварительно настроенная форма в OneEntry, идентифицированная маркером (например, 'contact_us').
  • Предварительно настроенные поля формы.

📌 Важно:

  • Обрабатывайте потенциальные ошибки во время запросов к API корректно, чтобы предоставить обратную связь пользователям.
  • Соблюдайте конфиденциальность и безопасность данных, особенно при обработке чувствительной информации, такой как адреса электронной почты.
  • Держите поля формы и их маркеры в синхронизации с конфигурацией на сервере, чтобы избежать несоответствий.
  • Мы не обрабатываем ошибки в этих примерах.
  • Вы можете обрабатывать ошибки в конструкции 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 { AuthProvider, Orders, Payments, Forms } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

3. Получите форму с помощью Forms.getFormByMarker()​

Пример:

const formData = await Forms.getFormByMarker('contact_us');
Результат:
[
  {
    "type": "string",
    "marker": "first_name",
    "isLogin": null,
    "isSignUp": null,
    "position": 1,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {
      "requiredValidator": {
        "strict": true
      }
    },
    "localizeInfos": {
      "title": "Имя"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "string",
    "marker": "email",
    "isLogin": null,
    "isSignUp": null,
    "position": 2,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {
      "requiredValidator": {
        "strict": true
      },
      "emailInspectionValidator": true
    },
    "localizeInfos": {
      "title": "Электронная почта"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "string",
    "marker": "surname",
    "isLogin": null,
    "isSignUp": null,
    "position": 3,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {
      "stringInspectionValidator": {
        "stringMax": 0,
        "stringMin": 0,
        "stringLength": 0
      }
    },
    "localizeInfos": {
      "title": "Фамилия"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "list",
    "marker": "topic",
    "isLogin": null,
    "isSignUp": null,
    "position": 4,
    "settings": {},
    "isVisible": true,
    "listTitles": [
      {
        "title": "Статья",
        "value": "article",
        "extended": {
          "type": null,
          "value": null
        },
        "position": 1
      },
      {
        "title": "Статья-2",
        "value": "article-2",
        "extended": {
          "type": null,
          "value": null
        },
        "position": 2
      }
    ],
    "validators": {
      "requiredValidator": {
        "strict": true
      }
    },
    "localizeInfos": {
      "title": "Тема"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "text",
    "marker": "text",
    "isLogin": null,
    "isSignUp": null,
    "position": 5,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {},
    "localizeInfos": {
      "title": "Текст"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "spam",
    "marker": "spam",
    "isLogin": null,
    "isSignUp": null,
    "position": 6,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {},
    "localizeInfos": {
      "title": "Вы не робот?"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  },
  {
    "type": "button",
    "marker": "send",
    "isLogin": null,
    "isSignUp": null,
    "position": 7,
    "settings": {},
    "isVisible": true,
    "listTitles": [],
    "validators": {},
    "localizeInfos": {
      "title": "Отправить"
    },
    "additionalFields": [],
    "isNotificationEmail": null,
    "isNotificationPhoneSMS": null,
    "isNotificationPhonePush": null
  }
]

4. Получите данные полей из фронтенд-формы​

Пример:

[
  {
    "marker": "first_name",
    "value": "Firstname"
  },
  {
    "marker": "surname",
    "value": "Surname"
  },
  {
    "marker": "email",
    "value": "your@email.com"
  },
  {
    "marker": "topic",
    "value": [
      {
        "title": "Article",
        "value": "article"
      }
    ]
  },
  {
    "marker": "text",
    "value": "Некоторый текст"
  }
]

5. Преобразуйте данные для использования с формой OneEntry​

Пример:

const transformedFormData = fieldsData.map((field: any) => {
  const { marker, value } = field;
  const formField = formFields.find(
    (field: { marker: string }) => field.marker === marker,
  );
  const { type } = formField;

  switch (type) {
    case 'text':
      return {
        marker,
        type: 'text',
        value: [
          {
            htmlValue: value,
            plainValue: value,
          },
        ],
      };
    default:
      return {
        marker,
        type,
        value,
      };
  }
});
Результат:
[
  {
    "marker": "first_name",
    "type": "string",
    "value": "Firstname"
  },
  {
    "marker": "surname",
    "type": "string",
    "value": "Surname"
  },
  {
    "marker": "email",
    "type": "string",
    "value": "your@email.com"
  },
  {
    "marker": "topic",
    "type": "list",
    "value": [
      {
        "title": "Article",
        "value": "article"
      }
    ]
  },
  {
    "marker": "text",
    "type": "text",
    "value": [
      {
        "htmlValue": "Некоторый текст",
        "plainValue": "Некоторый текст"
      }
    ]
  }
]

6. Отправьте FormsData с помощью FormData.postFormsData()​

Пример:

const formResponse = await FormData.postFormsData({
  formIdentifier: 'contact_us',
  formData: transformedFormData,
});
Результат:
{
  "formData": {
    "formIdentifier": "contact_us",
    "time": "2025-04-30T20:12:39.209Z",
    "formData": [
      {
        "marker": "first_name",
        "type": "string",
        "value": "Firstname"
      },
      {
        "marker": "surname",
        "type": "string",
        "value": "Surname"
      },
      {
        "marker": "email",
        "type": "string",
        "value": "your@email.com"
      },
      {
        "marker": "topic",
        "type": "list",
        "value": [
          {
            "title": "Article",
            "value": "article"
          }
        ]
      },
      {
        "marker": "text",
        "type": "text",
        "value": [
          {
            "htmlValue": "Некоторый текст",
            "plainValue": "Некоторый текст"
          }
        ]
      }
    ],
    "id": 68
  },
  "actionMessage": "Сообщение об успешной обработке данных"
}

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

// 1. Импортируйте oneEntry и определите PROJECT_URL и APP_TOKEN
import { defineOneEntry } from 'oneentry';

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

// 2. Создание API-клиента 
const { FileUploading, FormData } = defineOneEntry(PROJECT_URL, {
  token: APP_TOKEN,
});

// 3. Получите форму и отсортируйте поля по позиции
const formData = await Forms.getFormByMarker('contact_us');
const formFields = formData?.attributes.slice().sort(
  (a: { position: number }, b: { position: number }) =>
    a.position - b.position,
);

// 4. Получите данные полей из фронтенд-формы
const fieldsData = [
  {
    marker: 'first_name',
    value: 'Firstname',
  },
  {
    marker: 'surname',
    value: 'Surname',
  },
  {
    marker: 'email',
    value: 'your@email.com',
  },
  {
    marker: 'topic',
    value: [
      {
        title: 'Article',
        value: 'article',
      },
    ],
  },
  {
    marker: 'text',
    value: 'Некоторый текст',
  },
];

// 5. Преобразуйте данные для использования с формой OneEntry 
const transformedFormData = fieldsData.map((field: any) => {
  const { marker, value } = field;
  const formField = formFields.find(
    (field: { marker: string }) => field.marker === marker,
  );
  const { type } = formField;

  switch (type) {
    case 'text':
      return {
        marker,
        type: 'text',
        value: [
          {
            htmlValue: value,
            plainValue: value,
          },
        ],
      };
    default:
      return {
        marker,
        type,
        value,
      };
  }
});

// 6. Отправьте FormsData с помощью FormData.postFormsData()
const formResponse = await FormData.postFormsData({
  formIdentifier: 'contact_us',
  formData: transformedFormData,
});
console.log(formResponse);