Formularerstellung
Automatische Erstellung von Dateien auf Ihrer Webseite - Diplome, Zertifikate oder andere Dokumente. Ein Besucher Ihrer Seite muss lediglich das Formular ausfüllen und die Datei erhalten.
Um Dateien zu erstellen, muss ein HTML-Formular auf Ihrer Webseite erstellt werden. Falls dies nicht möglich ist, sollten Sie einfach das Erstellungs-Widget nutzen.
Formularerstellung
Um Anfragen zur Dateierstellung an DiMaker zu senden, müssen Sie ein Formular auf Ihrer Webseite erstellen. Dieses Formular kann sowohl im öffentlichen als auch im geschützten Bereich Ihrer Webseite platziert werden. Erstellen Sie mit Ihrem CMS eine Seite und fügen Sie dort das Formular ein.
Formularaktion
https://dimaker.app/api/v1/webform-create/
Formularfelder
Sie müssen einige versteckte Felder mit den folgenden Werten erstellen:
-
secure*
Token (Zeichenkette, 36 Zeichen)
-
doc_id*
Dokumenten-ID (Zeichenkette, 36 Zeichen), die zur Dateierstellung verwendet wird. Die Dokumenten-ID können Sie in der Adressleiste sehen, wenn das Dokument geöffnet ist. Das Dokument darf sich nicht im Papierkorb befinden, kann jedoch in jedem beliebigen Ordner liegen.
-
mail_id
ID der E-Mail-Vorlage (Zeichenkette, 36 Zeichen) für den Versand per E-Mail. Diese ID können Sie in der Adressleiste sehen, wenn die Vorlage geöffnet ist. Wird die Variable nicht übermittelt, erfolgt kein E-Mail-Versand.
-
email_send
Der Zeitpunkt, zu dem die Datei per E-Mail versendet werden soll. Mögliche Werte:
onfinish – Alle E-Mails werden nach der Erstellung aller Dateien versendet (Standardwert).
oncreate – E-Mails werden sofort nach der Dateierstellung versendet. Bei der Erstellung einer einzelnen Datei sind onfinish und oncreate identisch.
timeout – E-Mails werden nach einem bestimmten Zeitintervall gesendet. In diesem Fall müssen zwei zusätzliche Parameter übermittelt werden:
email_timeout_value – Numerischer Wert des Intervalls in ganzen Zahlen.
email_timeout_unit – Zeiteinheit des Intervalls. Mögliche Werte sind "m" (Minuten), "h" (Stunden) oder "d" (Tage).
Alternativ können Sie den genauen Versandzeitpunkt im Unix-Zeitformat in email_timeout_timestamp angeben. Falls timeout und email_timeout_timestamp übermittelt werden, hat letzterer Vorrang. -
folder_id
ID des Ordners im Speicher (Zeichenkette, 36 Zeichen), in dem die Dateien gespeichert werden. Falls kein Ordner existiert, wird er automatisch bei der ersten Dateierstellung erstellt.
-
page_id
Blattnummer (Zahl oder Zeichenkette), falls das Dokument mehrere Blätter enthält. Sie können eine einzelne Nummer (erstes Blatt = 0) oder mehrere durch Kommas getrennte Nummern angeben, die für die Dateierstellung verwendet werden.
Sich selbst die Datei zusenden
Die Datei wird sofort nach der Erstellung an die E-Mail-Adresse des Kontos gesendet. Über das Feld „E-Mail-Vorlage“ können Sie auswählen, welche Vorlage für den Versand verwendet wird. Vorab können Sie in den E-Mail-Vorlagen eine eigene Vorlage für den Versand an Ihre E-Mail-Adresse erstellen. Falls Sie im Text der E-Mail die Variable %data verwenden, werden alle Dateiinformationen im Tabularformat an dieser Stelle eingefügt.
Skript und Stile
Sie können den Code auf der Integrationsseite abrufen und in den HEAD-Bereich oder an eine beliebige Stelle auf Ihrer Seite einfügen. Der Code muss nicht auf alle Seiten Ihrer Webseite eingefügt werden, sondern nur auf die Seite mit dem Formular.
Außerdem müssen Sie zwei Elemente mit den IDs result-success und result-danger erstellen. Beide sollten verborgen sein – mit dem CSS-Stil display:none. Ins erste Element können Sie den Text für eine erfolgreiche Dateierstellung schreiben. Dieser Block wird bei einer erfolgreichen Anfrage angezeigt. Bei einem Fehler wird der Block mit der ID result-danger angezeigt. Der Fehlertext wird automatisch in den Block eingefügt.
Platzhalter im Dokument
In Ihrem Dokument sollte mindestens eine Variable zum Ersetzen vorhanden sein, beispielsweise %name oder %course. Fügen Sie im Formular ein Feld hinzu, dessen Name mit mask_ beginnt, z. B. mask_name oder mask_course. Die vom Besucher eingegebenen Daten in diesen Feldern werden durch die entsprechenden Variablen im Dokument ersetzt. Für die Angabe der E-Mail-Adresse verwenden Sie die Variable mask_email. Falls Sie E-Mails an mehrere Adressen senden möchten, geben Sie diese durch Komma oder Leerzeichen getrennt an. Der Sende-Status wird in diesem Fall nur für die erste Adresse im Speicher angezeigt.
Formularverhalten
Nach Erstellung des Formulars können Sie die veröffentlichte Seite aufrufen und die Funktionsweise des Formulars testen. Eine Datei wird erstellt und in einem Pop-up-Fenster zum Download bereitgestellt.
Ein Dokument = eine Einreichung
Optional können Sie die Anzahl der Einreichungen einschränken. Falls bereits mit der angegebenen E-Mail-Adresse eine Datei mit doc_id erstellt wurde, wird eine Warnung angezeigt, dass nur eine Datei erstellt werden kann.
Meine Dokumente
Sie können Dokumente eines Nutzers im geschützten Bereich Ihrer Webseite anzeigen. Erstellen Sie dazu ein Formular wie oben beschrieben und fügen Sie die versteckten Felder email, secure und doc_id hinzu. Im ersten Feld geben Sie die E-Mail-Adresse des Nutzers an, und im letzten Feld den Wert all. Beim Aufruf dieser Seite sieht der Nutzer anstelle des Formulars eine Liste aller seiner Dokumente mit der Möglichkeit, diese herunterzuladen. Falls der Nutzer das Formular bereits ausgefüllt hat, kann ihm direkt die Datei angezeigt werden. Das E-Mail-Feld im Formular sollte in diesem Fall versteckt sein und automatisch durch Ihr CMS ausgefüllt werden.