Форма создания
Автоматическое создание файлов на вашем сайте - дипломов, сертификатов или чего то другого. Посетителю вашего сайта достаточно будет заполнить форму и получить файл.
Для создания файлов требуется создать HTML форму на вашем сайте. Если это не возможно, то следует просто использовать виджет создания.
Создание формы
Чтобы отправлять запросы на создания файлов в ГрамотаДел, вам нужно создать форму на своём сайте. Эта форма может располагаться как в публичной, так и в закрытой части вашего сайта. При помощи вашей CMS создайте страницу и форму на странице.
Action формы
https://gramotadel.express/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), или номера (через запятую) листов, которые нужно использовать для создания файла.
Отправлять себе файл после создания
Файл будет отправлен на электронную почту аккаунта сразу же после того, как будет создан. В поле «Шаблон письма» можно выбрать, какой шаблон использовать для отправки. Предварительно в Шаблонах писем можно создать отдельный шаблон для отправки писем на электронную почту аккаунта. Если в тексте письма написать переменную %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.