ГрамотаДел ГрамотаДел Express В чём разница?

Создание дипломов и сертификатов из Getcourse

Настройте автоматическое создание и рассылку дипломов и сертификатов из GetCourse после окончания тренинга или вебинара. Ссылка на готовый диплом будет сохранена в данных ученика в GetCourse.


С чего начать?

Вам нужно 1) создать или загрузить шаблон, 2) создать документ, заполнить его. В том месте, где будут данные подставляться из GetCourse поставьте строку для замены, например %name или %city. Если вы хотите отправлять письмо на email 3) напишите текст письма (в Письма - Шаблоны).

Создание сертификата об прохождении тренинга в GetCourse - шаблон документа Документ в ГрамотаДеле c переменной %name


Создание процесса

Чтобы отправлять запросы на создания файлов в ГрамотаДеле, вам нужно создать процесс в GetCourse. Для этого откройте "Задачи" - "Процессы". Далее - "Создать процесс". Заполните название и выберите "Тип объекта" - "Пользователи".

Создание сертификата об прохождении тренинга в GetCourse - создание процесса Окно создания процесса

Далее в процессе, выберите вкладку "Процесс" и справа "Добавить блок" - "Операция".

Создание сертификата об прохождении тренинга в GetCourse - создание процесса Окно создания процесса - добавление вызова URL

В появившемся окне выберите "Вызвать URL" (самый последний пункт") и нажмите "Сохранить".

Создание сертификата об прохождении тренинга в GetCourse - окно задачи Окно создания процесса - окно задачи

Это основное окно, с которым мы будем работать. Выберите метод POST, а в поле URL укажите строку запроса, которая должна содержать:

  • Адрес запроса - https://gramotadel.express/api/v1/create/?
  • Токен API - secure (взять в настройках, в ГрамотаДеле)
  • ID документа - doc_id Документ, на основании которого будет выдан сертификат или диплом
  • ID папки - folder_id Папка на Диске, в которую нужно будет положить файл
  • ID письма - mail_id Шаблон письма, который будет использоваться для отправки файла
  • Данные для замены, каждая переменная, начинающиеся с mask_

Вначале рассмотрим все эти данные подробнее, а затем - как в итоге должна выглядет строка запроса.


Переменные

В запросе должны быть переменные, которые обеспечивают доступ к вашему аккаунту в ГрамотаДеле, указывают на то, какой документ использовать, в какую папку в Диске сохранять файл и так далее.

Обазятельные переменные формы помечены звёздочкой.

Имя Описание Комментарии
secure * API токен Нужно получить в ГрамотаДеле, в настройках. Там же нужно включить приём запросов через API.
doc_id * ID документа ID документа нужно получить в адресной строке при его открытии. Документ не должен быть в корзине, но может лежать в любой паке в Документах. Создание сертификата об прохождении тренинга в GetCourse - id документа
folder_id ID папки в Диске ID папки можно посмотреть в адресной строке, открыв в Диске нужную папку. ID папки не меняется при её перемещении в другую папку. Если поле не передано, то при первом создании файла будет создана папка. Все остальные файлы будут сохраняться в эту папку. Создание сертификата об прохождении тренинга в GetCourse - id папки
mail_id ID письма ID письма нужно получить в адресной строке при его открытии. Если переменная не передана, то письмо отправлено не будет. Создание сертификата об прохождении тренинга в GetCourse - id письма
email_send Время отправки Время, когда отправлять письмо с файлом. Может принимать следующие значения:
onfinish - Разослать все письма после создания всех файлов (по-умолчанию)
oncreate - Отправлять письма сразу же после создания файла. При создании одного файла onfinish и oncreate идентичны.
timeout - Разослать письма через промежуток времени. В этом случае необходимо передать ещё две переменные:
email_timeout_value - цифровое значение промежутка, через который отправлять письма, целое значение
email_timeout_value - единица измерения промежутка. Может принимать значение "m" (минуты), "h" (часы), "d" (дни).
Либо, для указания точного времени отправки, передайте время в формате unix time в email_timeout_timestamp. Если переданы обе переменные, то приориет у последней.
genuine Лейбл проверки подлинности Лейбл для проверки подлинности готового файла. Может принимать следующие значения:
ID лейбла Указанный лейбл будет нанесён на файл. ID плейбла можно посмотреть в заголовке окна, открыв его.
none - не добавлять лейбл проверки подлинности. Эквивалентно отсутствию поля в форме.
yadisk Яндекс.Диск Добавлять ли готовые файлы на ваш Яндекс.Диск. Может принимать следующие значения:
all - добавлять создаваемые файлы в отдельную папку.
all-f - добавлять создаваемые файлы в папку "Готовые файлы".

Переменные

В документе ГрамотаДела у вас должна быть хотя бы одна переменная для замены, например %name или %city. Переменная должна быть написана латиницей. Кирилические %фио или %класс использовать нельзя.

При составлении URL в процесах имя переменной должно начинаться со слова mask_, и далее - переменная из Документа. Например, если в документе у вас %name, то имя переменной в URL - mask_name, если у документе переменная %city, то имя переменной - mask_city. Указанные для этих переменных данные будут доставлены в Документ в ГрамотаДеле при создании сертификата или диплома.

Сами данные можно взять из того, что предоставляет GetCourse, список вот на этой странице (подзаголовок Переменные по объекту «Пользователи»). Значение должно быть в фигурных скобках, с префиксом object., например {object.first_name}

Если необходимо отправлять готовый файл по электронной почте, то используйте переменную mask_email, а значение - {object.email}, а если задать имя готового файла - mask_filename.

Таких переменных в документе может быть любое количество. Вы можете передать в ГрамотаДел любые данные из профиля пользователя в GetCourse, в том числе и из дополнительных полей, чтобы затем их нанести на готовый файл.

Если нужно вставить текущую дату, случайный номер или другие данные - используйте функции при создании.


Составление строки запроса

Итак, теперь можно составить строку URL для Задачи. Лучше это делать в любом редакторе, а затем скопировать в поле URL в Задаче. URL запроса может выглядеть так (цвета для удобства):

https://gramotadel.express/api/v1/create/?mask_name={object.last_name}%20{object.first_name}&mask_city={object.city}&mask_level={object.Уровень}&mask_email={object.email}&doc_id=b75b01cf-c732-49c6-80a0-77dd051a8299&folder_id=5a390b28-9845-4c01-b94a-7d252b115e2e&mail_id=fb5eff48-4c08-4df7-a9e6-29e17896317c&secure=8453bc41-с34у-4ead-80e8-c4e76175a11b

Разберём строку по-порядку:

  • https://gramotadel.express/api/v1/create/? - адрес запроса
  • mask_name={object.last_name}%20{object.first_name} - в переменную %name в документе будет подставлены имя и фамилия из профиля в GetCourse. Обратите внимание, что между именем и фамилией нужен пробел. Его обозначение - %20
  • mask_city={object.city} - в переменную %city в документе будет подставлен город из профиля в GetCourse
  • mask_level={object.Уровень} - в переменную %level в документе будет подставлено значение из дополниельного поля "Уровень", из профиля в GetCourse
  • mask_email={object.email} - адрес электронной почты посетителя из профиля в GetCourse
  • doc_id=b75b01cf-c732-49c6-80a0-77dd051a8299 - ID Документа в ГрамотаДеле
  • folder_id=5a390b28-9845-4c01-b94a-7d252b115e2e - ID папки в Диске в ГрамотаДеле
  • mail_id=fb5eff48-4c08-4df7-a9e6-29e17896317c - ID шаблона письма в ГрамотаДеле
  • secure=8453bc41-с34у-4ead-80e8-c4e76175a11b - API секретный код из ГрамотаДела

Между переменными - знак &. Пробелы использовать нельзя. Очень, очень внимательно составьте строку, подставив свои данные и не потеряв ни одного символа. После сохранения Задачи, соедените "Начало работы" и "Задачу".

Создание сертификата об прохождении тренинга в GetCourse - процесс Окно создания процесса - процесс

В настройках ГрамотаДела включите приём запросов через API и затем выполните тестирование. Для этого, в GetCourse, там же, в Процессе, нажмите "Тестировать", выберите аккаунт, и поставьте галочку "Выполнять действия по настоящему". Если всё верно, в результате в папке на Диске появится файл диплома или сертификата. Если вы указали mail_id, то файл будет отправлен на электронную почту. Если файл не появился, в окне тестирования будет написана причина, почему запрос не выполнился.


Завершение настройки процеса

Если тестирование успешно, файл создался и все данные подставились, можно завершить настройку процесса. Для этого вернитесь на вкладку "Основные". В панели "Массовое создание задач", укажите "Переодическая проверка", а в "Правило вхождения объекта" - когда срабатывать процессу выдачи сертификата. Например - "Участник трегинга", выберите какой трениг, и "Завершил". В результате, GetCourse будет проверять все посетителей, кто завершил указанный трениг, и, если так оно и есть - запускать указанный процесс. В настройках Тренинга в GetCourse, обязательно укажите когда считать тренинг завершённым. После запуска процесса новые задачи будут добавляться для тех посетителей, кто соответствует условиям поиска. Обратите внимание, что GetCourse делает проверку один раз в 5-15 минут. Это значит, что если посетитель завершил трениг, то сам сертификат он получит в течение 15 минут (ГрамотаДел обрабатывает запро сразу же).

Как сделать, чтобы под процесс не попали все текущие посетители, которым уже выдан диплом через GetCourse или вручную? Там же, в "Правило вхождения объекта", добавьте ещё одно условие, нажав "и", и, например "Дата регистрации", укзав нужную дату, или группу посетителя.


Добавление в группу после выдачи сертификата

Если необходимо, в GetCourse можно создать группу "Сертификат выдан", в "Пользователи" - "Группы" и добавлять всех пользователей в эту группу, кому был выдан сертификат через ГрамотаДел. Для этого, в процессе, после выполнения запроса на URL, добавьте ещё один блок, операцию, "Добавить в группу", и укажите эту группу. Затем свяжите запрос к URL и добавление в групу. В результате, после выполнения запроса посетитель будет добавлен в нужную группу.


Сохранение ссылки на сертификат в профиле пользователя GetCourse

Если необходимо, в GetCourse вы можете сделать сохранение ссылки на диплом или сертификат в профиле пользователя, которому был выдан сертификат. Для этого добавьте дополнительное поле "Сертификат" в "Пользователи" - "Дополнительные поля" - "Добавить поле" - "Строка". Затем, в URL запроса в ГрамотаДел добавьте &result=link, а ниже в том же окне - "Записать результат в доп. поле" и выберите это поле. В результате после запроса ссылка на диплом будет добавлена в профиль посетителя.


Ручное одобрение выдачи сертификатов

Если вы хотите вручную проверять ФИО или другие данные, перед тем как выдать сертификат, то это можно сделать двумя путями.

Путь первый: в процессе, в окне с url поставьте галочку в "Менеджер должен подтвердить запуск". В итоге менеджер должен будет одобрить запуск задачи для конкретного посетителя.

Путь второй: создать три группы "Ожидание сертификата", "Выдать сертификат" и "Сертификат выдан". Затем, в процессах - два процесса. Первый процесс должен срабатывать, когда посетитель заканчивает тренинг и он должен добавляться в группу "Ожидание сертификата", а второй процесс - это запрос в ГрамотаДел, при условии, если посетитель есть в группе "Выдать сертификат". В том же процессе нужно добавить ещё две операции - удаление из группы "Выдать сертификат" и добавление в "Сертификат выдан". В итоге, после прохождения курса посетитель будет добавлен в группу "Ожидание сертификата", затем менеджер должен будет проверить все данные и перенести посетителя в группу "Выдать сертификат". Как только задача будет создана, посетитель будет перемещён в группу "Сертификат выдан".


Создание нескольких файлов в одном запросе

В одном запросе можно составить запрос на создание нескольких файлов из разных документов. С помощью такого запроса можно создать несколько файлов, например, используя шаблоны на русском и английском языке.

Чтобы создать такую форму, просто к имени поля doc_id добавьте две квадратные скобки, чтобы получилось doc_id[]. Затем добавьте ещё одну переменную doc_id[], но со значением ID другого нужного документа в ГрамотаДеле. Таких документов может быть любое количество. Другие поля, такие как genuine, email_send, mail_id, folder_id, yadisk тоже могут быть отправлены подобным образом.

Пример: необходимо создать два файла из разных документов и положить их в разные папки на Диске. Для этого необходимо создать два поля doc_id[] и два поля folder_id[]. Важно, все поля, имеющие несколько значений шли в одинаковом порядке. Т.е. первому doc_id[] будет соответствовать первый folder_id[], второму doc_id[] второй storage[]. Если второго folder_id[] не будет, то данные буду взяты с первого.

Другой пример: Отправить два файла одним письмом. Нужно создать поле mail_id, с ID письма и два email_send[]. В первом, в значении указать "manual", а во втором - "oncreate". Вначале будет создан первый файл (он не будет отправлен), завтем второй. Для второго файла указана отправка "oncreate", поэтому он будет отправлен сразу после создания. При отправке оба файла будут приложены к письму с указанным mail_id.

Данные для замены могут быть одинаковые (для этого просто используйте одинаковые переменные в документе), либо отличаться. Например, в одном документе вы используете %name_ru, а в другом - %name_en. В этом случае создайте два поля "Имя", с именем переменной - mask_name_ru и mask_name_en. Одно подставится в один документ, а другое - в другой.


Нужна помощь?

Напишите нам в техническую поддержку или через чат. Мы с радостью поможем вам!

Открыть