Інтеграція з GetCourse

Автоматичне створення та розсилка дипломів і сертифікатів із GetCourse після завершення тренінгу чи вебінару. Посилання на готовий диплом буде збережено в профілі учасника в GetCourse.

Створення процесу

Щоб надсилати запити на створення файлів у DiMaker, потрібно створити процес у GetCourse. Для цього відкрийте "Завдання" - "Процеси". Потім виберіть "Створити процес". Вкажіть назву й оберіть "Тип об’єкта" - "Користувачі".

Вікно створення процесу

Далі у процесі слід відкрити вкладку "Процес" і праворуч натиснути "Додати блок" - "Операція".

Вікно створення процесу - додавання виклику URL

У вікні, що з’явиться, потрібно вибрати "Викликати URL" (остання опція) та натиснути "Зберегти".

Вікно створення процесу - вікно завдання

Це основне вікно. Тут потрібно вибрати метод POST, а в полі URL вказати рядок запиту, який має включати:

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

Спершу розглянемо кожен із цих даних детальніше, а потім - як у підсумку має виглядати рядок запиту.

Змінні

У запиті мають бути змінні, які забезпечують доступ до облікового запису в DiMaker, визначають, який документ використовувати, у яку папку Диска зберігати файл тощо.

Обов’язкові змінні форми відмічені зірочкою.

• secure*

  Токен (рядок із 36 символів) зі сторінки "API токени" в DiMaker

• 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 timestamp у email_timeout_timestamp. Якщо вказані і timeout, і email_timeout_timestamp, пріоритет матиме timestamp.

• folder_id

  ID папки в Диску (рядок із 36 символів), куди зберігати файли. Якщо папки немає, вона буде автоматично створена під час створення першого файлу.

• page_id

  Номер сторінки (число або рядок), якщо в документі є кілька сторінок. Можна передати один номер (перша сторінка - 0) або кілька номерів через кому, які використовувати для створення файлу.

• result

  Вказує, у якому вигляді повертати результат. Можливі значення:

  • Відсутнє значення. Буде повернуто -рядок із результатом запиту (див. нижче).
  • link. У разі успішного запиту буде повернуто рядок із посиланням на створений файл (якщо було створено кілька файлів, то посилання на перший). Щоб отримати сам файл, потрібно перейти за цим посиланням. На створення файлів може знадобитися 1–5 секунд для кожного файлу. До моменту створення запит за цією адресою поверне 404. Якщо файл не створено, поверне помилку (див. нижче).
  • file. Успішний запит поверне готовий файл (якщо створень кілька, то тільки перший). Повернення файлу можливе лише після його створення (1–5 секунд). Якщо файл не створено за 30 секунд, API поверне помилку 404.

Змінні

У документі DiMaker обов’язково має бути мінімум одна змінна, наприклад %name або %city. Змінна має бути написана латиницею. Кириличні змінні, наприклад %ПІБ чи %клас, використовувати не можна. Адреса електронної пошти - %email.

Під час створення URL у процесах ім’я змінної має починатися зі слова mask_, далі - змінна з документа. Наприклад, якщо змінна в документі - %name, то в URL вона буде mask_name. Якщо змінна - %city, то в URL це буде mask_city. Дані для цих змінних буде передано в документ DiMaker під час створення файлу.

---

Інші інтеграції