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

Дакументацыя перакладзена аўтаматычна з выкарыстаннем машыннага навучання.

Аўтаматычнае стварэнне файлаў на вашым сайце – дыпломаў, сертыфікатаў і іншага. Наведвальніку вашага сайта трэба будзе толькі запоўніць форму і атрымаць файл.

Для стварэння файлаў неабходна размясціць 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, перавага аддаецца апошняму.

  • folder_id

    ID тэчкі ў сховішчы для захавання файлаў (радок, 36 сімвалаў). Калі тэчка адсутнічае, яна будзе створана аўтаматычна пры стварэнні першага файла.

  • page_id

    Нумар старонкі дакумента (лічба або радок), калі ў дакуменце ёсць некалькі старонак. Можна паказаць адзін нумар (першы ліст – 0) або нумары праз коску, якія будуць выкарыстоўвацца для стварэння файла.

Адпраўка файла сабе

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

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

На старонцы інтэграцыі вазьміце код і ўстаўце яго ў HEAD або іншае месца старонкі, дзе знаходзіцца форма. Код не патрабуецца размяшчаць на ўсіх старонках сайта.

Таксама трэба стварыць два блокі з id result-success і result-danger. Усталюйце іх як схаваныя (display:none). У першым блоку пішацца тэкст пра ўдалае стварэнне файла (адлюструецца, калі запыт апрацаваны паспяхова). У другім – тэкст памылкі, якія інструмент уставіць аўтаматычна.

Падстаноўка ў дакумент

У дакуменце павінна быць хаця б адна пераменная для падмены, напрыклад, %name або %course. Дадайце ў форму поле, дзе імя пераменнай пачынаецца з mask_, напрыклад, mask_name або mask_course. Уведзеныя наведвальнікам дадзеныя будуць замяняцца адпаведнымі зменнымі ў тэксце дакумента. Для падстаўлення email выкарыстоўвайце mask_email. Калі патрэбна адпраўка на некалькі адрасоў, пералічыце іх праз коску або прабел.

Праверка працы формы

Пасля стварэння формы апублікуйце старонку і праверце яе працаздольнасць. Файл будзе створаны і адлюстрованы ў акне для спампоўкі.

Адзін дакумент = адно запаўненне

Па жаданні, можна абмежаваць колькасць запаўненняў формы. Калі для унікальнага email быў ужо створаны файл з doc_id, выдаецца папярэджанне, што можна стварыць адзін файл.

Мае дакументы

Можна адлюстраваць дакументы карыстальніка ў закрытай частцы сайта. Для гэтага стварыце форму як апісана вышэй. Дадайце схаваныя палі email, secure і doc_id. У першае падстаўце email наведвальніка, а ў апошняе – значэнне all. Пасля адкрыцця старонкі наведвальнік убачыць спіс яго дакументаў з магчымасцю спампоўкі.


Іншыя інтэграцыі