Erstellungsformular
Automatische Erstellung von Dateien auf Ihrer Website - Diplome, Zertifikate oder anderes. Ein Besucher Ihrer Website muss lediglich das Formular ausfüllen, um die Datei zu erhalten.
Für die Erstellung von Dateien ist es notwendig, ein HTML-Formular auf Ihrer Website zu erstellen. Falls dies nicht möglich ist, sollten Sie einfach das Erstellungs-Widget verwenden.
Formularerstellung
Um Anfragen zur Dateierstellung in DiMaker zu senden, müssen Sie ein Formular auf Ihrer Website erstellen. Dieses Formular kann sowohl im öffentlichen als auch im geschlossenen Bereich Ihrer Website platziert werden. Erstellen Sie eine Seite und ein Formular darauf mithilfe Ihres CMS.
Formular-Action
https://dimaker.app/api/v1/webform-create/Formularfelder
Sie müssen mehrere versteckte Felder mit den folgenden Werten erstellen:
-
secure*
Token (Zeichenkette, 36 Zeichen)
-
doc_id*
Dokument-ID (Zeichenkette, 36 Zeichen), die zur Erstellung der Datei verwendet wird. Die ID kann in der Adressleiste abgerufen werden, wenn das Dokument geöffnet ist. Das Dokument darf nicht im Papierkorb sein, kann sich aber in jedem Verzeichnis Dokumente befinden.
-
mail_id
ID der E-Mail-Vorlage (Zeichenkette, 36 Zeichen) für den Versand per E-Mail. Die ID kann in der Adressleiste abgerufen werden, wenn die Vorlage geöffnet ist. Wird diese Variable nicht übermittelt, wird keine E-Mail versandt.
-
email_send
Zeitpunkt, wann die E-Mail mit der Datei versandt wird. Mögliche Werte sind:
onfinish - Sende alle E-Mails nach der Erstellung aller Dateien (Standardmäßig)
oncreate - Sende E-Mails sofort nach der Dateierstellung. Bei der Erstellung einer einzigen Datei sind onfinish und oncreate identisch.
timeout - Sende E-Mails nach einem Zeitintervall. Hierbei müssen zwei weitere Parameter übermittelt werden:
email_timeout_value - numerischer Wert des Intervalls, nach dem die E-Mails gesendet werden sollen, ganze Zahl
email_timeout_unit - Einheit des Intervalls. Mögliche Werte sind "m" (Minuten), "h" (Stunden), "d" (Tage).
Alternativ, um die genaue Sendezeit anzugeben, muss die Zeit im Unix-Format email_timeout_timestamp übermittelt werden. Wenn sowohl timeout als auch email_timeout_timestamp übermittelt werden, hat letzteres Priorität. -
storage_period
Speicherzeit der Dateien im Drive. Wird dieser Parameter nicht angegeben, werden die Dateien auf unbestimmte Zeit gespeichert, bis sie manuell gelöscht werden. Um nach einem Intervall zu löschen, sollte der Wert timeout sein. In diesem Fall müssen zwei weitere Parameter übermittelt werden:
storage_period_timeout_value - numerischer Wert des Intervalls, nach dem die Dateien gelöscht werden, ganze Zahl
storage_period_timeout_unit - Einheit des Intervalls. Mögliche Werte sind "m" (Minuten), "h" (Stunden), "d" (Tage).
Alternativ, um die genaue Löschzeit anzugeben, muss die Zeit im Unix-Format storage_period_timeout_timestamp übermittelt werden. Wenn sowohl storage_period_timeout_value als auch email_timeout_timestamp übermittelt werden, hat letzteres Priorität. -
folder_id
ID des Ordners im Drive (Zeichenkette, 36 Zeichen) zum Speichern der Dateien. Wenn der Ordner nicht vorhanden ist, wird er automatisch bei der Erstellung der ersten Datei erstellt.
-
page_id
Seitennummer (Zahl oder Zeichenkette), wenn das Dokument mehrere Seiten hat. Es kann eine einzelne Nummer (erste Seite - 0) oder mehrere Nummern (durch Komma getrennt) übermittelt werden, die für die Erstellung der Datei verwendet werden sollen.
Erhalte die Datei nach der Erstellung selbst
Die Datei wird sofort nach ihrer Erstellung an die E-Mail-Adresse des Kontos gesendet. Im Feld „E-Mail-Vorlage“ kann ausgewählt werden, welche Vorlage für den Versand verwendet werden soll. Im Voraus kann unter E-Mail-Vorlagen eine eigene Vorlage für den Versand von E-Mails an die E-Mail-Adresse des Kontos erstellt werden. Wenn im E-Mail-Text die Variable %data geschrieben wird, werden an dieser Stelle alle Dateidaten in Tabellenform hinzugefügt.
Skript und Styles
Auf der Integrationsseite muss der entsprechende Code kopiert und in den HEAD oder an einen anderen Ort der Seite eingefügt werden. Dieser Code muss nicht auf allen Seiten der Website eingefügt werden. Er ist nur auf der Seite mit dem Formular erforderlich.
Außerdem müssen Sie zwei Blöcke mit den ID result-success und result-danger erstellen. Beide Blöcke sind versteckt, mit dem Stil display:none; In den ersten Block können Sie einen Text für die erfolgreiche Erstellung der Datei schreiben. Dieser Block wird bei erfolgreicher Anfrage angezeigt. Wenn ein Fehler auftritt, wird der Block mit der ID result-danger angezeigt. Der Fehlertext wird automatisch in den Block eingefügt.
Platzhalter im Dokument
Im Dokument muss mindestens eine Variable für die Ersetzung vorhanden sein, zum Beispiel %name oder %course. Fügen Sie im Formular ein Feld hinzu, wobei der Variablenname mit mask_ beginnen sollte, z.B. mask_name oder mask_course. Die vom Besucher eingegebenen Daten in diesem Feld werden durch die entsprechenden Variablen im Dokumenttext ersetzt. Um die E-Mail-Adresse anzugeben, verwenden Sie die Variable mask_email. Für den Versand von E-Mails an mehrere Adressen, geben Sie diese durch Komma oder Leerzeichen getrennt an. Dabei wird der Versandstatus im Drive über die erste Adresse angezeigt.
Funktionsweise des Formulars
Nach der Erstellung des Formulars können Sie die veröffentlichte Seite öffnen und die Funktionalität des Formulars testen. Eine Datei wird erstellt und in einem Popup-Fenster zum Download angezeigt.
Ein Dokument = eine Ausfüllung
Auf Wunsch können Sie die Anzahl der Ausfüllungen des Formulars begrenzen. Wenn für die angegebene E-Mail bereits eine Datei mit doc_id erstellt wurde, wird eine Warnung angezeigt, dass nur eine Datei erstellt werden kann.
Meine Dokumente
Sie können die Dokumente einer Person im geschlossenen Bereich Ihrer Website anzeigen lassen. Dazu erstellen Sie ein Formular, wie oben beschrieben. Fügen Sie dann verborgene Felder für E-Mail, secure und doc_id ein. Im ersten Feld die E-Mail-Adresse des Besuchers, im letzten Feld den Wert all angeben. Beim Öffnen dieser Seite sieht der Besucher anstelle des Formulars eine Liste aller seiner Dokumente mit der Möglichkeit, sie herunterzuladen. Wenn Sie möchten, dass wenn der Besucher das Formular bereits ausgefüllt hat, ihm stattdessen seine Datei angezeigt wird, muss das E-Mail-Feld des Formulars verborgen und automatisch durch Ihr CMS eingefügt werden.