 Integration mit GetCourse

Automatische Erstellung und Versand von Diplomen und Zertifikaten aus GetCourse nach Abschluss eines Trainings oder Webinars. Der Link zum fertigen Diplom wird in den Daten des Schülers in GetCourse gespeichert.

Prozesserstellung

Um Anfragen zur Erstellung von Dateien in DiMaker zu senden, muss in GetCourse ein Prozess erstellt werden. Öffnen Sie dafür "Tasks" – "Prozesse". Dann klicken Sie auf "Prozess erstellen". Geben Sie einen Namen an und wählen Sie "Objektart" - "Benutzer".

Prozess-Erstellungsfenster

Anschließend wählen Sie im Prozess den Tab "Prozess" und rechts "Block hinzufügen" – "Operation".

Prozess-Erstellungsfenster – URL-Aufruf hinzufügen

Im erscheinenden Fenster wählen Sie "URL aufrufen" (letzter Punkt) und klicken Sie auf "Speichern".

Prozess-Erstellungsfenster – Aufgabenfenster

Dies ist das Hauptfenster. Wählen Sie die Methode POST aus und geben Sie im URL-Feld die Anfragesequenz an, die folgendes enthalten sollte:

• Anfrageadresse - https://dimaker.app/api/v1/create/?
• API-Token - secure (zu finden in den Einstellungen von DiMaker)
• ID des Dokuments - doc_id Das Dokument, auf dessen Basis das Zertifikat oder Diplom erstellt wird
• ID des Ordners - folder_id Der Ordner im Drive, in dem die Datei gespeichert wird
• ID der E-Mail-Vorlage - mail_id Die Vorlage, die für den E-Mail-Versand der Datei verwendet wird
• Ersetzungsdaten, jede Variable beginnt mit mask_

Zuerst betrachten wir diese Daten im Detail, bevor wir zeigen, wie die endgültige Anfragesequenz aussehen sollte.

Variablen

Die Anfrage muss Variablen enthalten, die den Zugang zu Ihrem DiMaker-Account gewährleisten, das zu verwendende Dokument angeben, den Zielordner im Drive festlegen und vieles mehr.

Pflichtfelder sind mit einem Sternchen markiert.

• secure*

  Token (36-stellige Zeichenkette), zu finden auf der Seite "API-Tokens" in DiMaker

• doc_id*

  ID des Dokuments (36-stellige Zeichenkette), das zur Datei-Erstellung verwendet wird. Die ID können Sie aus der Adressleiste kopieren, wenn das Dokument geöffnet ist. Das Dokument darf sich nicht im Papierkorb befinden, kann jedoch in jedem Dokumentenordner abgelegt sein.

• mail_id

  ID der E-Mail-Vorlage (36-stellige Zeichenkette), die für den Versand genutzt wird. Die ID kann in der Adressleiste abgelesen werden, wenn die Vorlage geöffnet ist. Ist die Variable nicht angegeben, wird keine E-Mail versendet.

• email_send

  Zeitpunkt, wann die Datei versandt wird. Dies kann folgende Werte annehmen:
  onfinish – E-Mails werden nach Abschluss der Datei-Erstellung verschickt (Standardwert)
  oncreate – E-Mails werden sofort nach Dateierstellung gesendet. Bei einer einzelnen Datei ist onfinish und oncreate gleichwertig.
  timeout – Der Versand der E-Mails erfolgt nach einem bestimmten Zeitintervall. In diesem Fall müssen zwei zusätzliche Parameter mitgegeben werden:
  email_timeout_value – Zahl, die das Intervall in ganzen Zahlen beschreibt
  email_timeout_unit – Intervall-Einheit: "m" (Minuten), "h" (Stunden), "d" (Tage).
  Alternativ können Sie ein spezifisches Sendezeitpunkt im Unix-Zeitformat als email_timeout_timestamp angeben. Sind sowohl ein timeout als auch ein timestamp angegeben, so hat letzterer Priorität.

• folder_id

  ID des Ordners im Drive (36-stellige Zeichenkette), in dem die Datei gespeichert wird. Falls der Ordner nicht existiert, wird er bei der ersten Datei-Erstellung automatisch erstellt.

• page_id

  Seitennummer (Zahl oder Zeichenkette), falls das Dokument mehrere Seiten enthält. Sie können eine einzelne Seite (erste Seite beginnt bei 0) oder mehrere Seiten (durch Kommata getrennt) angeben, die zur Erstellung verwendet werden sollen.

• result

  Gibt an, in welchem Format das Ergebnis zurückgegeben wird. Mögliche Werte:

  • Kein Wert. Ein -String mit dem Ergebnis wird zurückgegeben (siehe unten).
  • link. Bei erfolgreicher Anfrage wird eine URL zum erstellten Dokument zurückgegeben (falls mehrere Dateien erstellt wurden, nur für die erste). Um die Datei abzurufen, rufen Sie die angegebene URL auf. Die Erstellung der Datei dauert 1–5 Sekunden. Bis die Datei bereit ist, wird die URL 404 zurückliefern. Wenn die Anfrage keine Datei erstellt, wird ein Fehler als zurückgegeben (siehe unten).
  • file. Bei erfolgreicher Anfrage wird die fertige Datei zurückgegeben (bei mehreren Dateien nur die erste). Da die Erstellung der Datei Zeit benötigt (1–5 Sekunden), wird die Rückgabe erst nach Fertigstellung erfolgen. Bei hoher API-Belastung kann sich die Erstellungszeit verlängern. Sollte die Datei nicht innerhalb von 30 Sekunden erstellt werden, gibt die API einen 404 Fehler zurück. (Die Anfragesequenz im Hintergrund wird dennoch abgeschlossen.) Falls die Anfragenlast mehr als eine Anfrage pro 5 Sekunden beträgt, vermeiden Sie die Verwendung dieser Option.

Variablen für Platzhalter

Im DiMaker-Dokument sollte mindestens ein Platzhalter vorhanden sein, z. B. %name oder %city. Platzhalter sollten in lateinischer Schrift geschrieben sein. Kyrillische Platzhalter wie %фио oder %класс sind nicht erlaubt. Für E-Mail-Adressen verwenden Sie %email.

Beim Aufbau der URL in den Prozessen sollte der Variablenname mit mask_ beginnen, gefolgt vom Platzhalternamen im Dokument. Wenn im Dokument beispielsweise %name verwendet wird, sollte der Variablenname in der URL mask_name lauten, und %city wird zu mask_city. Die für diese Variablen übergebenen Werte werden bei der Erstellung der Datei in das Dokument eingefügt.

Die nötigen Daten können aus den bereitgestellten Informationen von GetCourse entnommen werden, eine Liste finden Sie auf dieser Seite (siehe Unterpunkt Variablen für das Objekt „Benutzer“). Der Wert sollte in geschweiften Klammern stehen und den Präfix object. haben, z. B. {object.first_name}.

Wenn Sie die fertige Datei per E-Mail versenden möchten, verwenden Sie die Variable mask_email mit dem Wert {object.email}. Falls Sie den Dateinamen angeben möchten, nutzen Sie mask_filename.

Im Dokument können beliebig viele Variablen enthalten sein. Sie können sämtliche Benutzerprofile-Daten aus GetCourse an DiMaker übergeben, einschließlich zusätzlicher Felder, um diese dann auf dem Dokument anzubringen.

Benötigen Sie das aktuelle Datum, eine Zufallsnummer oder weitere vordefinierte Werte, nutzen Sie bitte Funktionen.

Erstellung der Anfragesequenz

Nun können Sie die URL für die Aufgabe zusammenstellen. Es empfiehlt sich, dies in einem Editor zu tun und anschließend in das URL-Feld der Aufgabe zu kopieren. Eine typische Anfragesequenz könnte folgendermaßen aussehen (Farben dienen der Übersicht):

Analyse der Sequenz:

• https://dimaker.app/api/v1/create/? – Anfrageadresse
• mask_name={object.last_name}%20{object.first_name} – Für den Platzhalter %name werden Vor- und Nachname aus dem Benutzerprofil in GetCourse eingefügt. Beachten Sie, dass zwischen Name und Nachname ein Leerzeichen (%20) eingefügt werden muss.
• mask_city={object.city} – Für den Platzhalter %city wird die Stadt aus dem Benutzerprofil eingefügt.
… [Gleiche Erklärungen für folgende Variablen wie in der russischen Version] …

Weitere Integrationen