Integracja z GetCourse

Automatyczne tworzenie i wysyłanie dyplomów i certyfikatów z GetCourse po zakończeniu szkolenia lub webinaru. Link do gotowego dyplomu zostanie zapisany w profilach użytkowników w GetCourse.

Tworzenie procesu

Aby wysyłać zapytania do usługi DiMaker w celu tworzenia plików, należy utworzyć proces w GetCourse. Otwórz "Zadania" - "Procesy". Następnie kliknij "Utwórz proces". Wypełnij nazwę i wybierz "Typ obiektu" - "Użytkownicy".

Okno tworzenia procesu

Następnie w procesie wybierz zakładkę "Proces" i po prawej stronie kliknij "Dodaj blok" - "Operacja".

Okno tworzenia procesu - dodanie wywołania URL

W otwartym oknie wybierz "Wywołaj URL" (ostatnia opcja) i kliknij "Zapisz".

Okno tworzenia procesu - okno zadania

To główne okno. Wybierz metodę POST, a w polu URL wprowadź ciąg zapytania, który powinien zawierać:

• Adres zapytania - https://dimaker.app/api/v1/create/?
• Token API - secure (do pobrania w ustawieniach DiMaker)
• ID dokumentu - doc_id Dokument, na podstawie którego zostanie utworzony certyfikat lub dyplom
• ID folderu - folder_id Folder na Dysku, w którym zostanie zapisany plik
• ID szablonu wiadomości - mail_id Szablon wiadomości używany do wysłania pliku
• Dane do zamiany, każda zmienna zaczynająca się od mask_

Najpierw szczegółowo przeanalizujemy te dane, a następnie pokażemy, jak powinna wyglądać finalna forma zapytania.

Zmienne

Zapytanie powinno zawierać zmienne, które umożliwiają dostęp do konta w DiMaker, określają dokument do użycia, folder na Dysku do zapisania pliku i inne dane.

Zmienne oznaczone gwiazdką (*) są obowiązkowe.

• secure*

  Token (ciąg 36 znaków) dostępny na stronie "Tokeny API" w DiMaker

• doc_id*

  ID dokumentu (ciąg 36 znaków), który ma być używany do tworzenia pliku. ID można znaleźć w pasku adresu po otwarciu dokumentu. Dokument nie powinien znajdować się w koszu, ale może być w dowolnym folderze Dokumentów.

mail_id

ID szablonu wiadomości (ciąg 36 znaków) używanego do wysyłania e-mailem. ID można znaleźć w pasku adresu po otwarciu szablonu. Jeśli zmienna nie zostanie przekazana, wiadomość nie zostanie wysłana.

• email_send

  Czas wysłania wiadomości z plikiem. Możliwe wartości:
  onfinish – Wyślij wszystkie wiadomości po utworzeniu wszystkich plików (domyślnie)
  oncreate – Wyślij wiadomości natychmiast po utworzeniu pliku. W przypadku jednego pliku onfinish i oncreate są identyczne.
  timeout – Wyślij wiadomości po określonym czasie. W takim przypadku należy przekazać dodatkowe dwa parametry:
  email_timeout_value – wartość liczbowa odstępu, po którym wysyłać wiadomości, wartość całkowita
  email_timeout_unit – jednostka miary odstępu: "m" (minuty), "h" (godziny), "d" (dni).
  Lub, aby wskazać dokładny czas wysyłki, można przekazać dane w formacie unix time w zmiennej email_timeout_timestamp. Jeśli są przekazane zarówno timeout, jak i email_timeout_timestamp, priorytet ma wartość timestamp.

• folder_id

  ID folderu na Dysku (ciąg 36 znaków), w którym mają być zapisane pliki. Jeśli folder nie istnieje, zostanie stworzony automatycznie przy pierwszym pliku.

• page_id

  Numer strony (liczba lub ciąg), jeśli dokument zawiera kilka stron. Można podać jeden numer (pierwsza strona to 0) lub numery (oddzielone przecinkiem) stron do użycia przy tworzeniu pliku.

• result

  Określa, w jakiej formie zwracać wynik. Możliwe wartości:

  • Brak wartości. Zwrócona zostanie -owa odpowiedź z wynikiem zapytania (opis niżej).
  • link. Przy udanym zapytaniu zwrócony zostanie link do utworzonego pliku (jeśli tworzono wiele plików, zwrócony zostanie link do pierwszego).
  • file. Przy udanym zapytaniu zostanie zwrócony gotowy plik. W przypadku zapytań API większych niż jeden co 5 sekund, nie zaleca się używania tej opcji.

Zmienne dokumentu

W dokumencie DiMaker musi znaleźć się przynajmniej jedna zmienna odpowiednia do podstawienia, np. %name lub %city. Zmienne muszą być zapisane w łacińskim alfabecie. Zmienne takie jak %фио czy %класс nie mogą być używane.

Inne integracje