Форма створення
Автоматичне створення файлів на вашому сайті - дипломів, сертифікатів чи чогось іншого. Відвідувачу вашого сайту достатньо буде заповнити форму і отримати файл.
Для створення файлів потрібно створити 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_unit – одиниця вимірювання проміжку. Може приймати значення "m" (хвилини), "h" (години), "d" (дні).
Або, для вказання точного часу відправки, потрібно передати час у форматі unix time в email_timeout_timestamp. Якщо передано timeout та email_timeout_timestamp, то пріоритет буде у останнього. -
storage_period
Час зберігання файлів на Диску. Якщо параметр не вказано, файли зберігаються безстроково, до видалення вручну. Для видалення через проміжок часу потрібно прийняти значення:
timeout. У цьому випадку необхідно передати ще два параметри:
storage_period_timeout_value – цифрове значення проміжку, через який видалити файли, ціле значення
storage_period_timeout_unit – одиниця вимірювання проміжку. Може приймати значення "m" (хвилини), "h" (години), "d" (дні).
Або, для вказання точного часу видалення, потрібно передати час у форматі unix time в storage_period_timeout_timestamp. Якщо передано storage_period_timeout_value та email_timeout_timestamp, то пріоритет буде у останнього. -
folder_id
ID теки на Диску (рядок, 36 символів) збереження файлів. Якщо теки немає, вона буде створена автоматично при створенні першого файлу.
-
page_id
Порядковий номер листа (число або рядок), якщо у документі є кілька листів. Можна передати один номер (перший лист - 0), або номери (через кому) листів, які потрібно використовувати для створення файлу.
Відправляти файл собі після створення
Файл буде відправлено на електронну пошту акаунту одразу, як тільки його буде створено. У полі «Шаблон листа» можна вибрати, який шаблон використовувати для відправки. Попередньо в Шаблони листів можна створити окремий шаблон для відправки листів на електронну пошту акаунту. Якщо у тексті листа написати змінну %data, то замість неї буде додано всі дані файлу у вигляді таблиці.
Скрипт та стилі
На сторінці інтеграції потрібно взяти код і вставити його в HEAD або будь-яке інше місце сторінки. Не варто вставляти цей код на всі сторінки сайту. Необхідно вставити цей код лише на сторінку з формою.
Крім того, вам потрібно створити два блоки з id result-success та result-danger. Обидва блоки приховані, за стилем display:none; У перший блок ви можете написати текст з успішним створенням файлу. Цей блок буде показано у разі успішного запиту. Якщо сталася якась помилка, буде виведено блок з id result-danger. Текст помилки буде вставлено у блок автоматично.
Підстановка в документ
У документі повинна бути хоча б одна змінна для заміни, наприклад %name чи %course. Додайте у формі поле, де ім'я змінної повинно починатися з mask_, наприклад mask_name чи mask_course. Введені відвідувачем дані у ці поля будуть замінені на відповідні змінні у тексті документа. Для вказання адреси електронної пошти використовуйте змінну mask_email. Для відправки листів на кілька адрес вкажіть їх через кому або пробіл. При цьому статус відправки на Диску буде відображатися за першою адресою.
Робота форми
Після створення форми ви можете відкрити опубліковану сторінку та перевірити роботу форми. Буде створено файл і виведено у вікні для завантаження.
Один документ = одне заповнення
За бажанням, ви можете обмежити кількість заповнень форми. Якщо на зазначений email вже було створено файл з doc_id, то виведеться попередження, що можна створити тільки один файл.
Мої документи
Ви можете вивести документи людини у закритій частині вашого сайту. Для цього створіть форму, як зазначено вище. Потім додайте приховані поля email, secure та doc_id. У перше вкажіть адресу електронної пошти відвідувача, а в останнє поле вкажіть значення all. При відкритті цієї сторінки відвідувач побачить на місці форми список всіх документів з можливістю їх скачати. Якщо ви бажаєте, щоб якщо відвідувач вже заповнював форму, то замість форми йому виводився його файл, поле email форми повинно бути прихованим та вставленим автоматично вашою CMS.