API

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

Выкарыстоўваючы API DiMaker, можна ствараць файлы з персаналізаванымі дадзенымі і, пры неабходнасці, адпраўляць іх атрымальнікам. Запыты да API могуць выконвацца як з іншага сервера, так і з браўзера праз CORS-запыты.

З чаго пачаць

У раздзеле «Інтэграцыя» – «Токены API» неабходна атрымаць Secure токен для запытаў і дазволіць яго выкарыстанне. Таксама трэба стварыць дакумент са зменнымі для персаналізаваных дадзеных, шаблон ліста для рассылкі па электроннай пошце і тэчку на Дыску для гатовых файлаў.

Стварэнне файлаў

Для стварэння файлаў неабходна адправіць POST-DATA, POST- ці GET-запыты на адрас:
https://dimaker.app/api/v1/create/
з указанымі ніжэй дадзенымі.
Кадаванне запытаў – UTF-8. Абавязковыя палі адзначаны зорачкай.

  • secure*

    Токен (тэкставы радок, 36 сімвалаў)

  • doc_id*

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

  • mask*

    -радок, які ўтрымлівае ўсе зменныя для замены ў фармаце ключ (зменная) – значэнне (тэкст для замены). Можа змяшчаць дадзеныя для стварэння некалькіх файлаў (без абмежаванняў па колькасці).
    Напрыклад, для аднаго файла:
    [{"%name": "Іваноў", "%балы":"100"}]
    Для некалькіх файлаў:
    [{"%name": "Іваноў", "%балы":"100"}, {"%name": "Пятроў", "%балы":"200"}, {"%name": "Сідараў", "%балы":"300"}]
    Для пазначэння адраса электроннай пошты выкарыстоўвайце %email, а для імя файла – %filename. Для адпраўкі файлаў на некалькі адрасоў электроннай пошты адрасы пазначаюцца праз коску. Статус адпраўкі на Дыску адлюстроўваецца па першаму адрасу.
    Дапускаюцца толькі падвойныя двукосся ў адпаведнасці са стандартам. Калі значэнне ключа змяшчае двукосся, яны павінны быць экранізаваны.

    Для перадачы выявы ў блоку з малюнкам можна выкарыстаць або прамую спасылку (http:// або https://), або малюнак у фармаце Base64, што пачынаецца са "data:image/".

    Альтэрнатыўны метад
    Калі адпраўка -радка немагчымая, радкі для замены можна перадаць як палі запыту, прытрымліваючыся фармату mask_<назва змяннай>. Напрыклад, mask_name для змяннай %name. Для пазначэння адраса электроннай пошты выкарыстоўвайце mask_email, для імя файла – mask_filename.

  • mail_id

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

  • email_send

    Час адпраўкі ліста. Можа мець наступныя значэнні:
    onfinish – адпраўка пасля стварэння ўсіх файлаў (па змаўчанні).
    oncreate – адпраўка адразу пасля стварэння файла. Пры аднаразовым стварэнні onfinish і oncreate эквівалентныя.
    timeout – заданне інтэрвалу для адпраўкі. У гэтым выпадку неабходна ўказаць:
    email_timeout_value - лічбавае значэнне інтэрвалу ў цэлых значэннях
    email_timeout_unit - адзінкі часу ("m" – хвіліны, "h" – гадзіны, "d" – дні).
    Альбо дакладны час у фармаце unix time праз email_timeout_timestamp. Калі зададзены абодва параметра, прыярытэт мае другі.

  • folder_id

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

  • page_id

    Нумар аркуша (лічба ці тэкст), калі дакумент мае некалькі аркушаў. Можна перадаць аднаго аркуша ці некалькі нумароў праз коску.

  • result

    Фармат выніку. Значэнні:

    • Не ўказана. Верне -радок з вынікам.
    • link. Верне спасылку на створаны файл.
    • file. Верне сам файл. Выпадак для вялікай колькасці запытаў можа быць рызыкоўным.

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