Форма створення

Документація переведена автоматично з використанням машинного навчання.

Автоматичне створення файлів на вашому сайті — дипломів, сертифікатів або чогось іншого. Відвідувачу вашого сайту достатньо буде заповнити форму та отримати файл.

Для створення файлів необхідно створити HTML-форму на вашому сайті. Якщо це неможливо, варто скористатися віджетом створення.

Створення форми

Щоб надсилати запити на створення файлів у DiMaker, вам необхідно створити форму на вашому сайті. Ця форма може знаходитись як у публічній, так і в закритій частині вашого сайту. За допомогою вашої CMS створіть сторінку та форму на сторінці.

Action форми

https://dimaker.app/api/v1/webform-create/

Поля форми

Вам необхідно створити кілька прихованих полів із такими значеннями:

  • secure*

    Токен (рядок, 36 символів)

  • doc_id*

    ID документа (рядок, 36 символів), який використовуватиметься для створення файлу. ID можна отримати в адресному рядку при відкритті документа. Документ не повинен бути в кошику, але може зберігатися у будь-якій папці Документів.

  • mail_id

    ID шаблону листа (рядок, 36 символів) для надсилання на електронну пошту. ID можна отримати в адресному рядку при відкритті шаблону. Якщо змінна не передана, лист не буде відправлено.

  • email_send

    Час, коли потрібно надсилати лист із файлом. Може мати такі значення:
    onfinish — Розіслати всі листи після створення всіх файлів (за замовчуванням)
    oncreate — Відправляти листи одразу після створення файлу. Під час створення одного файлу onfinish і oncreate працюють однаково.
    timeout — Розіслати листи через проміжок часу. У такому разі потрібно передати ще два параметри:
    email_timeout_value — цифрове значення проміжку часу для відправки, ціле число
    email_timeout_value — одиниця виміру проміжку. Може приймати значення "m" (хвилини), "h" (години), "d" (дні).
    Або, щоб вказати точний час відправки, потрібно передати час у форматі unix time у email_timeout_timestamp. Якщо передані значення "timeout" і "email_timeout_timestamp", пріоритет матиме останнє.

  • folder_id

    ID папки на Диску (рядок, 36 символів) для збереження файлів. Якщо така папка відсутня, вона буде створена автоматично під час створення першого файлу.

  • page_id

    Порядковий номер листа (число або рядок), якщо в документі є кілька листів. Можна передати один номер (перший лист — 0) або номери (через кому), які потрібно використовувати для створення файлу.

Надсилання файлу на свій email після створення

Файл буде надіслано на електронну адресу акаунту одразу після створення. У полі «Шаблон листа» можна вибрати, який шаблон використовувати для відправки. Попередньо в Шаблонах листів можна створити окремий шаблон для відправки файлів. У тексті листа ви можете написати змінну %data, у яку автоматично буде підставлена інформація у вигляді таблиці.

Скрипт і стилі

На сторінці інтеграції потрібно взяти код та вставити його в HEAD або будь-яке інше місце сторінки. Не обов’язково вставляти цей код на всі сторінки сайту. Його необхідно розмістити лише на сторінці з формою.

Також вам потрібно створити два блоки з id result-success і result-danger. Обидва блоки мають бути приховані (display:none;). У перший блок можна вказати текст повідомлення про успішне створення файлу. Він буде відображений у разі успішного запиту. Якщо сталася помилка, буде виведено блок із id result-danger. Текст із описом помилки вставляється в блок автоматично.

Підстановка у документ

У документі повинна бути хоча б одна змінна для заміни, наприклад %name або %course. У формі потрібно додати поле, де ім'я змінної починається з mask_, наприклад mask_name або mask_course. Дані, введені відвідувачем у ці поля, замінять відповідні змінні в тексті документа. Для адреси електронної пошти використовуйте змінну mask_email. Якщо потрібно відправити кілька листів, вкажіть декілька email-адрес через кому або пробіл. У цьому випадку статус буде показано для першої адреси.

Робота форми

Після створення форми ви можете відкрити опубліковану сторінку та перевірити її роботу. Буде створено файл і він з’явиться у спливаючому вікні для завантаження.

Один документ = одне заповнення

За бажанням, ви можете обмежити кількість заповнень форми. Якщо на вказаний email уже було створено файл із doc_id, відвідувач побачить попередження, що можна створити лише один файл.

Мої документи

Ви можете вивести список документів для користувача у закритій частині вашого сайту. Для цього створіть форму, як зазначено вище, і додайте приховані поля email, secure і doc_id. У поле email передайте адресу електронної пошти користувача, а в doc_id — значення all. При відкритті цієї сторінки відвідувач побачить список доступних для завантаження документів. Якщо він заповнював форму раніше, замість форми відображатиметься його створений файл. У цьому випадку поле email має бути прихованим і автоматично заповнюватися вашою CMS.


Інші інтеграції