Integration mit GetCourse
Automatisches Erstellen und Versenden von Diplomen und Zertifikaten aus GetCourse nach Abschluss eines Trainings oder Webinars. Der Link zum fertigen Diplom wird in den Schülerdaten in GetCourse gespeichert.
Prozess erstellen
Um Anfragen zur Erstellung von Dateien in DiMaker zu senden, müssen Sie einen Prozess in GetCourse erstellen. Dazu müssen Sie "Aufgaben" - "Prozesse" öffnen. Dann - "Prozess erstellen". Geben Sie einen Namen ein und wählen Sie "Objekttyp" - "Benutzer".
Fenster zum Erstellen eines Prozesses
Als nächstes müssen Sie im Prozess den Reiter "Prozess" auswählen und rechts "Block hinzufügen" - "Operation".
Fenster zum Erstellen eines Prozesses - Hinzufügen eines URL-Aufrufs
In dem sich öffnenden Fenster sollten Sie "URL aufrufen" (der letzte Punkt) auswählen und "Speichern" drücken.
Fenster zum Erstellen eines Prozesses - Aufgabenfenster
Dies ist das Hauptfenster. Sie müssen die POST-Methode auswählen und in das URL-Feld den Anfragestring eingeben, der Folgendes enthalten sollte:
- URL-Adresse - https://dimaker.app/api/v1/create/?
- API-Token - secure (in den Einstellungen in DiMaker zu finden)
- Dokumenten-ID - doc_id Das Dokument, auf dessen Grundlage das Zertifikat oder Diplom ausgestellt wird
- Ordner-ID - folder_id Der Ordner auf der Festplatte, in den die Datei gelegt werden muss
- E-Mail-ID - mail_id Die E-Mail-Vorlage, die zum Versenden der Datei verwendet wird
- Zu ersetzende Daten, jede Variable, die mit mask_ beginnt
Zunächst betrachten wir diese Daten genauer und dann, wie die Anfragezeichenfolge am Ende aussehen sollte.
Variablen
Im Skript müssen Variablen vorhanden sein, die den Zugriff auf das DiMaker-Konto ermöglichen, angeben, welches Dokument zu verwenden ist, in welchem Ordner die Datei auf dem Laufwerk gespeichert wird usw.
Pflichtfelder der Formularvariablen sind mit einem Sternchen gekennzeichnet.
-
secure*
Token (Zeichenfolge, 36 Zeichen) von der "API-Token" -Seite in DiMaker
-
doc_id*
ID des Dokuments (Zeichenfolge, 36 Zeichen), das zum Erstellen der Datei verwendet wird. Die ID kann in der Adressleiste abgerufen werden, wenn das Dokument geöffnet ist. Das Dokument darf nicht im Papierkorb liegen, kann jedoch in einem beliebigen Dokumentpaket liegen.
-
mail_id
ID der E-Mail-Vorlage (Zeichenfolge, 36 Zeichen) zum Versenden per E-Mail. Die ID kann in der Adressleiste abgerufen werden, wenn die Vorlage geöffnet ist. Wenn die Variable nicht übergeben wird, wird keine E-Mail gesendet.
-
email_send
Zeitpunkt, zu dem die E-Mail mit der Datei gesendet werden soll. Kann folgende Werte annehmen:
onfinish - Alle E-Mails nach der Erstellung aller Dateien senden (Standard)
oncreate - Senden Sie E-Mails unmittelbar nach Erstellung der Datei. Wenn nur eine Datei erstellt wird, sind onfinish und oncreate identisch.
timeout - Senden Sie E-Mails in einem Zeitintervall. Sie müssen zwei weitere Parameter übergeben:
email_timeout_value - Numerischer Wert des Intervalls, nach dem E-Mails gesendet werden sollen, als Ganzzahlwert.
email_timeout_unit - Maßeinheit des Intervalls. Kann den Wert "m" (Minuten), "h" (Stunden), "d" (Tage) annehmen.
Alternativ können Sie die Zeit zum Senden in Unix-Zeitstempel-Format in email_timeout_timestamp übergeben. Wenn timeout und email_timeout_timestamp übergeben werden, hat letzteres Priorität. -
folder_id
ID des Ordners auf dem Laufwerk (Zeichenfolge, 36 Zeichen), in dem die Dateien gespeichert werden sollen. Wenn der Ordner nicht vorhanden ist, wird er automatisch beim Erstellen der ersten Datei erstellt.
-
page_id
Sequenznummer des Blatts (Zahl oder Zeichenfolge), wenn das Dokument mehrere Blätter enthält. Sie können eine Nummer (erstes Blatt - 0) oder Nummer (durch Kommata getrennt) der Blätter übergeben, die zum Erstellen der Datei verwendet werden müssen.
-
result
Bestimmt, wie das Ergebnis zurückgegeben wird. Kann folgende Werte annehmen:
- Kein Wert vorhanden. Eine JSON-Zeichenfolge mit dem Ergebnis des Skripts wird zurückgegeben (siehe unten).
- Link. Bei erfolgreicher Ausführung des Skripts wird eine Zeichenfolge mit einem Link zum erstellten Dokument zurückgegeben (wenn mehrere Dateien erstellt wurden, wird nur der erste zurückgegeben). Um das eigentliche Dokument zu erhalten, rufen Sie den angegebenen Link auf. Es dauert 1-5 Sekunden, um die Dateien vorzubereiten. Bevor die Datei erstellt wird, gibt dieser Skript-Service einen Fehler 404 zurück. Wenn das Skript nicht zum Erstellen der Datei führt, wird eine JSON-Zeichenfolge mit einem Fehler zurückgegeben (siehe unten).
- Datei. Bei erfolgreicher Ausführung des Skripts wird die bereitgestellte Datei zurückgegeben (wenn mehrere Dateien erstellt wurden, wird nur die erste zurückgegeben). Das Erstellen der Datei dauert 1-5 Sekunden, daher wird die Antwort erst nach Abschluss dieses Vorgangs zurückgegeben. Bei vielen API-Anfragen dauert die Erstellung der Datei länger. Wenn die Datei nicht innerhalb von 30 Sekunden vorbereitet wird, gibt die API einen Fehler 404 zurück, auch wenn das Skript letztendlich zum Erstellen der Datei führt. Wenn erwartet wird, dass es mehr als 1 Skript pro 5 Sekunden gibt, sollte dieser Parameter nicht verwendet werden.
Variablen
Im DiMaker-Dokument muss mindestens eine Variable für die Ersetzung vorhanden sein, wie zum Beispiel %name oder %city. Die Variable muss auf Latein geschrieben werden. Kyrillische %фио oder %класс dürfen nicht verwendet werden. E-Mail-Adresse - %email.
Beim Erstellen der URL in Prozessen muss der Variablenname mit dem Wort mask_ beginnen, gefolgt von der Variablen im Dokument. Zum Beispiel, wenn die Variable %name im Dokument ist, ist der Name der Variablen in der URL mask_name. Wenn die Variable %city im Dokument ist, ist der Name der Variablen mask_city. Die angegebenen Daten für diese Variablen werden dem Dokument in DiMaker beim Erstellen der Datei zugestellt.
Die Daten können aus dem von GetCourse bereitgestellten Angebot entnommen werden, die Liste finden Sie auf dieser Seite (Untertitel Variablen für das "Benutzer"-Objekt). Der Wert muss in geschweiften Klammern mit dem Präfix object. stehen, zum Beispiel {object.first_name}.
Wenn eine fertige Datei per E-Mail gesendet werden soll, sollte die Variable mask_email verwendet werden, und der Wert sollte {object.email} und wenn ein Dateiname angegeben werden soll - mask_filename sein.
Es können beliebig viele solcher Variablen im Dokument vorhanden sein. Sie können in DiMaker beliebige Daten aus dem Benutzerprofil in GetCourse übertragen, einschließlich der zusätzlichen Felder, um sie dann auf einer fertigen Datei zu platzieren.
Wenn das aktuelle Datum, eine Zufallszahl oder andere Daten eingefügt werden müssen, sollten Funktionen verwendet werden.
Zusammenstellung des URL-Request-Strings
Jetzt können Sie also die URL für die Aufgabe erstellen. Es ist am besten, dies in einem Editor zu tun und dann in das URL-Feld in der Aufgabe zu kopieren. Die URL-Anforderung kann wie folgt aussehen (Farben für Bequemlichkeit):
Lassen Sie uns den String der Reihe nach betrachten:
- https://dimaker.app/api/v1/create/? - URL-Adresse
- mask_name={object.last_name}%20{object.first_name} - der Vor- und Nachname aus dem Profil in GetCourse wird in die Variable %name im Dokument eingefügt. Beachten Sie, dass zwischen Vor- und Nachnamen ein Leerzeichen stehen muss. Seine Bezeichnung ist %20.
- mask_city={object.city} - Der Stadtnamen aus dem Profil in GetCourse wird in die Variable %city im Dokument eingefügt
- mask_level={object.Level} - Der Wert aus dem zusätzlichen Feld "Level" im Profil in GetCourse wird in die Variable %level im Dokument eingefügt.
- mask_email={object.email} - Die E-Mail-Adresse des Besuchers aus dem Profil in GetCourse
- doc_id=b75b01cf-c732-49c6-80a0-77dd051a8299 - Die ID des Dokuments in DiMaker
- folder_id=5a390b28-9845-4c01-b94a-7d252b115e2e - Die ID des Ordners auf der Festplatte in DiMaker
- mail_id=fb5eff48-4c08-4df7-a9e6-29e17896317c - Die ID der Vorlagen-E-Mail in DiMaker.
- secure=8453bc41-c34у-4ead-80e8-c4e76175a11b - API geheimer Code aus DiMaker
Zwischen den Variablen befindet sich das Symbol &. Leerzeichen dürfen nicht verwendet werden. Der String muss sehr, sehr sorgfältig erstellt werden, indem Sie Ihre Daten einsetzen und kein einziges Zeichen verlieren. Nach dem Speichern der Aufgabe verbinden Sie "Beginn der Arbeit" und "Aufgabe".
Fenster Erstellung eines Prozesses - Prozess
Sie müssen die Annahme einer API-Anforderung in DiMaker-Einstellungen einschalten und dann testsen. Klicken Sie dazu in GetCourse im Prozess auf "Testen", wählen Sie ein Konto aus und aktivieren Sie das Kontrollkästchen "Aktionen tatsächlich ausführen". Wenn alles korrekt ist, wird in dem zugehörigen Ordner auf der Festplatte in DiMaker eine Diplom- oder Zertifikatsdatei angezeigt. Wenn Sie mail_id angegeben haben, wird die Datei an die angegebene E-Mail-Adresse gesendet. Wenn die Datei nicht angezeigt wird, wird in dem Testfenster angegeben, warum die API-Anforderung nicht ausgeführt wurde.
Einrichtung des Prozesses abschließen
Nach erfolgreichem Testen, Erstellung der Datei und Einfügen aller Daten kann die Einrichtung des Prozesses abgeschlossen werden. Gehen Sie dazu zurück auf die Registerkarte "Allgemein". Wählen Sie in der "Massenerstellung von Aufgaben" die Option "Periodische Überprüfung" und im Feld "Bedingungen für Objekte" das Ereignis, bei dem der Prozess zum Ausstellen von Zertifikaten ausgelöst werden soll. Zum Beispiel "Teilnehmer am Training", wählen Sie das entsprechende Training und "abgeschlossen". GetCourse wird nun alle Besucher prüfen, die das angegebene Training abgeschlossen haben, und wenn dies der Fall ist, den entsprechenden Prozess ausführen. In den Einstellungen des Trainings in GetCourse müssen Sie unbedingt angeben, wann das Training als abgeschlossen gilt. Nach dem Start des Prozesses werden neue Aufgaben für diejenigen Besucher hinzugefügt, die den Suchkriterien entsprechen. Beachten Sie, dass GetCourse alle 5-15 Minuten prüft. Dies bedeutet, dass der Besucher, der das Training abgeschlossen hat, das Zertifikat innerhalb von 15 Minuten erhält (DiMaker verarbeitet die Anforderung sofort).
Wie stellen Sie sicher, dass alle aktuellen Besucher, denen bereits ein Diplom über GetCourse oder manuell ausgestellt wurde, nicht in den Prozess gelangen? Fügen Sie im Bereich "Bedingungen für Objekte" eine weitere Bedingung hinzu, indem Sie "Und" wählen, und fügen Sie z.B. "Registrierungsdatum" hinzu und geben Sie das gewünschte Datum oder die Gruppe an.
Hinzufügen zur Gruppe nach der Vergabe des Zertifikats
Sie können in GetCourse eine Gruppe "Zertifikat erteilt" erstellen, indem Sie in "Benutzer" - "Gruppen" alle Benutzer hinzufügen, denen über DiMaker ein Zertifikat ausgestellt wurde. Fügen Sie im Prozess nach dem erfolgreichen Abschluss der Anforderung an eine URL einen weiteren Block "Zur Gruppe hinzufügen" hinzu und geben Sie diese Gruppe an. Verknüpfen Sie dann die Anforderung mit der URL und dem Hinzufügen zur Gruppe. Letztendlich wird der Besucher nach Abschluss der DiMaker-Anforderung der entsprechenden Gruppe hinzugefügt.
Speichern des Zertifikat-Links im Benutzerprofil von GetCourse
Sie können in GetCourse den Link zum Diplom oder Zertifikat im Profil des Benutzers, dem das Zertifikat ausgestellt wurde, speichern. Fügen Sie dazu ein zusätzliches Feld "Zertifikat" in "Benutzer" - "Zusätzliche Felder" - "Feld hinzufügen" - "Zeichenfolge" hinzu. Fügen Sie dann in der DiMaker-URL &result=link hinzu und wählen Sie im gleichen Fenster "Ergebnis in einem zusätzlichen Feld speichern" und wählen Sie dieses Feld aus. Dadurch wird nach der DiMaker-Anforderung der Link zum Diplom im Profil des Besuchers hinzugefügt.
Manuelle Genehmigung der Zertifikatsvergabe
Wenn Sie den Namen oder andere Daten manuell überprüfen möchten, bevor Sie ein Zertifikat ausstellen, können Sie dies auf zwei Arten tun.
Der erste Weg: Aktivieren Sie im Anforderungsfenster für die URL das Kontrollkästchen "Manager muss die Ausführung bestätigen". Infolgedessen muss der Manager die Ausführung für den jeweiligen Besucher genehmigen.
Der zweite Weg: Erstellen Sie drei Gruppen "Warte auf Zertifikat", "Zertifikat ausstellen" und "Zertifikat erteilt". Erstellen Sie dann zwei Prozesse in den Prozessen. Der erste Prozess muss ausgelöst werden, wenn ein Besucher das Training abschließt, und er muss zur Gruppe "Warte auf Zertifikat" hinzugefügt werden. Der zweite Prozess ist die Anfrage an DiMaker, unter der Bedingung, dass der Besucher Mitglied der Gruppe "Zertifikat ausstellen" ist. Fügen Sie in demselben Prozess weitere zwei Operationen hinzu - Entfernen aus der Gruppe "Zertifikat ausstellen" und Hinzufügen zur Gruppe "Zertifikat erteilt". Am Ende, nach Abschluss des Kurses, wird der Besucher der Gruppe "Warte auf Zertifikat" hinzugefügt. Dann muss der Manager alle Daten überprüfen und den Besucher in die Gruppe "Zertifikat ausstellen" verschieben. Sobald die Aufgabe erstellt wurde, wird der Besucher in die Gruppe "Zertifikat erteilt" verschoben.