API
Mit der API von DiMaker können personalisierte Dateien erstellt und bei Bedarf direkt an die Empfänger weitergeleitet werden. API-Anfragen können entweder von einem anderen Server oder direkt aus dem Browser über CORS gesendet werden.
Erste Schritte
Gehen Sie im Bereich „Integration“ zu „API-Tokens“, um ein sicheres Token für Ihre API-Anfragen zu generieren und dessen Verwendung freizugeben. Zusätzlich müssen Sie ein Dokument mit Variablen für die Personalisierung, eine E-Mail-Vorlage für den Versand sowie einen Ordner im Cloud-Speicher für fertiggestellte Dateien anlegen.
Dateien erstellen
Um Dateien zu erstellen, senden Sie POST-DATA-, POST-- oder GET-Anfragen an:
https://dimaker.app/api/v1/create/
mit den folgenden Angaben.
Die Kodierung der Anfrage ist UTF-8. Pflichtfelder sind mit einem Sternchen gekennzeichnet.
-
secure*
Token (String, 36 Zeichen)
-
doc_id*
ID des Dokuments (String, 36 Zeichen), das zur Erstellung der Datei verwendet wird. Die ID finden Sie in der Adressleiste, wenn das Dokument geöffnet ist. Das Dokument darf sich nicht im Papierkorb befinden, kann jedoch in jedem beliebigen Ordner in „Dokumente“ abgelegt sein.
-
mask*
-String mit Variablen zur Ersetzung im Format Schlüssel (Variable) - Wert (Text zur Ersetzung). Ermöglicht die Erstellung mehrerer Dateien (ohne Begrenzung der Anzahl).
Beispiel für eine Datei:
[{"%name": "Müller", "%punkte":"100"}]
Beispiel für mehrere Dateien:
[{"%name": "Müller", "%punkte":"100"}, {"%name": "Schmidt", "%punkte":"200"}, {"%name": "Meier", "%punkte":"300"}]
Um eine E-Mail-Adresse anzugeben, verwenden Sie %email, für den Dateinamen %filename. Bei der Angabe mehrerer E-Mail-Adressen (getrennt durch Kommas) wird der Versandstatus im Cloud-Speicher nur für die erste Adresse angezeigt.
Es dürfen nur doppelte Anführungszeichen verwendet werden. Wenn der Schlüsselwert bereits Anführungszeichen enthält, müssen diese maskiert werden.Für die Übertragung eines Bildes innerhalb eines Bildblocks können entweder ein direkter Link (http:// oder https://) oder ein in Base64 kodiertes Bild verwendet werden. Im Fall von Base64 sollte die Zeichenkette mit "data:image/" beginnen.
Alternative Methode
Falls keine -Strings gesendet werden können, können statt dessen Parameter als Felder in der Anfrage übermittelt werden. Jede Variable beginnt in diesem Fall mit mask_, z. B. mask_name, und enthält den zu ersetzenden Wert. Im Dokument wird dann die jeweilige Variable ohne Präfix gesucht. Beispielsweise entspricht die Variable %name dem Feld mask_name. Um eine E-Mail-Adresse anzugeben, verwenden Sie mask_email, und für den Dateinamen mask_filename. -
mail_id
ID der E-Mail-Vorlage (String, 36 Zeichen) für den Versand. Die ID finden Sie in der Adressleiste, wenn die Vorlage geöffnet ist. Wird die Variable nicht angegeben, wird keine E-Mail gesendet.
-
email_send
Zeitpunkt des Versands der E-Mail mit der Datei. Mögliche Werte sind:
onfinish - Alle E-Mails nach Fertigstellung aller Dateien versenden (Standardwert)
oncreate - E-Mails direkt nach der Erstellung jeder Datei versenden. Bei einer Einzelerstellung sind onfinish und oncreate identisch.
timeout - E-Mails nach einem Zeitintervall senden. In diesem Fall müssen zwei zusätzliche Parameter übermittelt werden:
email_timeout_value - Numerischer Wert für den Zeitabstand (Ganzzahl)
email_timeout_unit - Einheit des Zeitabstandes. Mögliche Werte sind "m" (Minuten), "h" (Stunden) oder "d" (Tage).
Alternativ kann der genaue Zeitpunkt im Unix-Timestamp-Format in email_timeout_timestamp übermittelt werden. Falls sowohl timeout als auch email_timeout_timestamp übermittelt werden, hat Letzteres Vorrang. -
folder_id
ID des Zielordners (String, 36 Zeichen) im Cloud-Speicher. Falls der Ordner nicht existiert, wird er beim Erstellen der ersten Datei automatisch angelegt.
-
page_id
Seitenzahl (Zahl oder String), falls das Dokument mehrere Seiten enthält. Entweder eine Seite (erste Seite = 0) oder mehrere Seiten (durch Kommas getrennt) können angegeben werden.
-
result
Bestimmt, in welchem Format das Resultat zurückgegeben wird. Mögliche Werte sind:
- Kein Wert. -String mit dem Ergebnis der Anfrage wird zurückgegeben (siehe unten).
- link. Erfolgreiche Anfrage liefert einen Link zur erstellten Datei. Bei mehreren Dateien wird der Link zur ersten Datei geliefert.
- file. Erfolgreiche Anfrage liefert die erste erstellte Datei.