Форма стварэння
Аўтаматычнае стварэнне файлаў на вашым сайце - дыпломаў, сертыфікатаў або чагосьці іншага. Наведвальніку вашага сайта дастаткова будзе запоўніць форму і атрымаць файл.
Для стварэння файлаў патрабуецца стварыць 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, то ў гэтае месца будуць дададзены ўсе даныя файла ў выглядзе табліцы.
Скрыпт і стылі
Акрамя таго, вам трэба стварыць два блока з id result-success і result-danger. Абодва блока схаваныя, са стылем display:none; У першый блок вы можаце напісаць тэкст з паспяховым стварэннем файла. Гэта блок будзе паказаны пры паспяховым запыце. Калі адбылася якая-небудзь памылка, то будзе выведзены блок з id result-danger. Тэкст памылкі будзе ўстаўлены ў блок аўтаматычна.
Падстаноўка ў дакумент
У дакуменце ў вас павінна быць хаця б адна змянная для замены, напрыклад %name або %course. Дадайце ў форме поле, дзе імя змяннай павінна пачынацца з mask_, напрыклад mask_name або mask_course. Уведзеныя наведвальнікам дадзеныя ў гэтыя палі будуць заменены на адпаведныя змянныя ў тэксце дакумента. Для ўказання адраса электроннай пошты выкарыстоўвайце змянную mask_email. Для адпраўкі лістоў на некалькі адрасоў укажыце іх праз коску або прабел. Пры гэтым статус адпраўкі на Дыску будзе адлюстроўвацца па першаму адрасу.
Работа формы
Пасля стварэння формы вы можаце адкрыць апублікаваную старонку і праверыць працу формы. Будзе створаны файл і выведзены ў ўсплываючым акне для спампоўкі.
Адзін дакумент = адно запаўненне
Па жаданні, вы можаце абмежаваць колькасць запаўненняў формы. Калі на ўказаную электронную пошту ўжо быў створаны файл з doc_id, то будзе выведзена папярэджанне, што можна стварыць толькі адзін файл.
Мае дакументы
Вы можаце вывеці дакументы чалавека ў закрытай частцы вашага сайта. Для гэтага стварыце форму, як указана вышэй. Затым дадайце схаванае поле email, secure і doc_id. У першае - адрас электроннай пошты наведвальніка, а ў апошняе поле ўкажыце значэнне all. Пры адкрыцці гэтай старонкі наведвальнік ўбачыць на месцы формы спіс усіх дакументаў з магчымасцю спампаваць іх. Калі вы хочаце, каб калі наведвальнік ужо запаўняў форму, то замест формы яму выводзіўся яго файл, поле email формы павінна быць схавана і аўтаматычна падстаўлена вашай CMS.