API
Mit dem DiMaker-API können Dateien mit persönlichen Daten erstellt und bei Bedarf an Empfänger gesendet werden. Der Zugriff auf das API kann von einem anderen Server aus oder über CORS-Anfragen aus einem Browser erfolgen.
Wo soll man anfangen
Im Abschnitt "Integration" - "API-Token" müssen Sie ein sicheres Token für Anfragen erhalten und die Verwendung dieses Tokens genehmigen. Darüber hinaus müssen Sie ein Dokument erstellen, das Variablen für persönliche Daten enthält, sowie eine E-Mail-Vorlagendatei für E-Mail-Verteilungen und einen Ordner im Laufwerk für die abgeschlossenen Dateien.
Erstellen von Dateien
Senden Sie zur Erstellung von Dateien POST-DATEN, POST-JSON- oder GET-Anfragen an die Adresse
https://dimaker.app/api/v1/create/
mit den unten angegebenen Daten.
Die Kodierung der Anfrage erfolgt in UTF-8. Pflichtfelder sind mit einem Stern gekennzeichnet.
Ergebnis
Als Ergebnis gibt der Server einen JSON-String zurück, der die folgenden möglichen Werte annehmen kann:
-
result
Das Ergebnis des Vorgangs. Kann die folgenden Werte annehmen:
error - Fehler beim Vorgang. Dateien wurden nicht erstellt.
Erfolg - erfolgreiche Erstellung von Dateien. Abhängig vom Anwendungsfall des APIs kann über die erfolgreiche Erstellung von Dateien informiert werden oder ein Formular zur Dateiabholung angezeigt werden. -
create_id
Generierungs-ID. Nur bei erfolgreicher Ausführung des Vorgangs. Kann für andere API-Anfragen nützlich sein.
-
files
Ein Array, das die IDs der erstellten Dateien enthält. Nur bei erfolgreicher Ausführung des Vorgangs. Um die Datei im JPG-Format zu erhalten, muss auf https://dimaker.app/getfile/{ID}/ zugegriffen werden. Zur PDF-Datei muss dem Link pdf/ hinzugefügt werden. Das API gibt die Datei-ID sofort zurück, aber die Dateivorbereitung dauert etwa 1 bis 5 Sekunden pro Datei. Bevor die Datei erstellt ist, wird ein Aufruf an https://dimaker.app/getfile/{ID}/ einen 404-Fehler zurückgeben.
-
url
URL-String zur Anzeige des Download-Widgets. Nur bei erfolgreicher Ausführung des Vorgangs. Ein Iframe mit der angegebenen URL erstellen. Ein einfacher Aufruf der URL liefert kein Ergebnis. Die Domain der Website, auf der der Dateiempfang erfolgt, muss in den API-Einstellungen korrekt angegeben sein.
Die Erstellung jeder Datei dauert 1 Sekunde plus einige Sekunden für die Verarbeitung der gesamten Gruppe. Sofort nach dem Absenden des Vorgangs kann das Iframe mit den angegebenen URLs geöffnet werden. Wenn die Dateierstellung noch nicht abgeschlossen ist, wird eine entsprechende Meldung angezeigt. Sobald die Dateien bereit sind, wird deren Download angeboten.
Das Download-Widget kann in einem Popup-Fenster über der Seite angezeigt werden. Hierfür muss ein Iframe mit den folgenden zusätzlichen Stilen erstellt werden: position:fixed; width:100%; height:100%; top:0; bottom:0; right:0; left:0; z-index:10000; background: rgb(0 0 0 / 72%); Dem Adressstring muss ?view=modal hinzugefügt werden. Und dieses Iframe im body platzieren. -
error_text
Nur bei einem Fehler. Textbeschreibung des Fehlers. Mögliche Fehler: ungültiges Secure-Token, Ersetzungsmaske, Dokumenten-ID, Vorlagenbrief-ID, Ordner-ID auf der Festplatte oder interner Serverfehler.
Beispiel für die zurückgegebenen Daten bei erfolgreichem Vorgang:
{
"result":"Erfolg",
"create_id":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"url":"https://embed.dimaker.app/widgets/get/927ebf68-2f55-4b20-a18c-c1171ee113db/b4caf05b-6757-4d9c-b4bc-1924a9b31796/",
"files":[
"369dc61e-40c2-46c0-81f4-e31ca8c33cc2",
"d94c6efb-0076-438b-bb84-fead9c1ae556",
"716e1081-c8ee-442b-b0b0-0681b2ed5d90"
]
}
Erstellen mehrerer Dateien in einem Request
In einem Request können mehrere Dateien aus verschiedenen Dokumenten erstellt werden. Mit einem solchen Request können mehrere Dateien erstellt werden, zum Beispiel unter Verwendung von Vorlagen in Russisch und Englisch. Nach dem Senden eines Requests erstellt der Server die erforderliche Anzahl von Dateien.
Um einen solchen Request zu senden, muss die Variable doc_id ein Array sein (Variablenname - doc_id[]). In diesem Fall können mehrere doc_id[]-Variablen in einem Request vorhanden sein, um mehrere Dateien zu erstellen. Andere Variablen wie mail_id, email_send, folder_id können auch als Arrays gesendet werden, um jedes der Dateien mit einem bestimmten Template, zu einer bestimmten Zeit oder in einen bestimmten Ordner zu senden. Wenn dies nicht erforderlich ist, sollte das Array nur das Feld doc_id enthalten.
Zum Beispiel, um zwei Dateien aus verschiedenen Dokumenten zu erstellen und in verschiedene Ordner auf dem Laufwerk zu legen. Dafür müssen zwei doc_id[]-Variablen und zwei folder_id[]-Variablen (in der gleichen Reihenfolge) gesendet werden. Darüber hinaus, wenn Sie sie in einer E-Mail senden möchten, müssen Sie eine mail_id angeben und in email_send[] zuerst "manual" und dann "oncreate" angeben. In diesem Fall wird zunächst eine Datei erstellt, dann die zweite. Und erst nach der Erstellung der zweiten Datei wird die angegebene E-Mail gesendet.
Senden einer Datei an sich selbst nach der Erstellung
Die Datei wird sofort nach der Erstellung an die E-Mail-Adresse des Kontos gesendet. Im Feld "E-Mail-Vorlage" können Sie auswählen, welche Vorlage zum Senden verwendet werden soll. Vorher kann in E-Mail-Vorlagen eine separate Vorlage für das Senden von E-Mails an die E-Mail-Adresse des Kontos erstellt werden. Wenn im E-Mail-Text die Variable %data verwendet wird, werden alle Dateidaten in Form einer Tabelle an dieser Stelle hinzugefügt.
Löschen von Dateien
Zum Löschen von Dateien müssen POST-DATA, POST-JSON oder GET-Requests an die Adresse geschickt werden
https://dimaker.app/api/v1/drive/files/delete/
mit den unten aufgeführten Daten.
Codierung des Requests - UTF-8. Pflichtfelder sind mit einem Sternchen markiert.
-
secure*
Token (Zeichenfolge, 36 Zeichen)
-
file_id
ID der Datei (Zeichenfolge, 36 Zeichen), die gelöscht werden soll. Die Datei-ID wird im Arrays files bei der Erstellung über die API zurückgegeben. Die Datei darf sich nicht im Papierkorb befinden.
ODER
-
file_ids
Array von Datei-IDs (Zeichenfolge, 36 Zeichen), die gelöscht werden sollen, wenn mehrere Dateien in einem Request gelöscht werden sollen.
ODER
creater_id
Erstellungs-ID (Zeichenfolge, 36 Zeichen), wenn die Datei über die API erstellt wurde. Die Erstellungs-ID kann anstelle von file_id oder file_ids übergeben werden. In diesem Fall werden alle Dateien mit dieser Erstellungs-ID gelöscht. Die Erstellungs-ID wird im Feld create_id bei der Erstellung von Dateien über die API zurückgegeben.
delete_forever
Soll die Datei endgültig gelöscht werden, ohne in den Papierkorb verschoben zu werden. Standardmäßig wird die Datei in den Papierkorb verschoben. Es kann die Werte annehmen:
- 0 - in den Papierkorb verschieben (Standard)
- 1 - endgültig löschen
Dateien im Papierkorb werden automatisch nach 60 Tagen gelöscht, nachdem sie in den Papierkorb verschoben wurden.
Beispiel
Beispiel eines korrekten Antrags zum Löschen von Dateien:
{
"secure":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"file_id":"369dc61e-40c2-46c0-81f4-e31ca8c33cc2"
}
Ergebnis
Als Ergebnis wird der Server einen JSON-String zurückgeben, der die folgenden möglichen Werte annimmt:
-
result
Ergebnis des Antrags. Kann die folgenden Werte annehmen:
error - Fehler beim Antrag. Dateien wurden nicht gelöscht.
success - erfolgreicher Antrag zum Löschen von Dateien. -
files
Array mit den IDs der gelöschten Dateien. Nur bei erfolgreicher Ausführung des Antrags.
-
error_text
Nur im Fehlerfall. Textuelle Beschreibung des Fehlers. Mögliche Fehler: ungültiges Sicherheitstoken, Datei-ID, Generierungs-ID oder interner Serverfehler.
Beispiel zurückgegebener Daten bei erfolgreichem Antrag:
{
"result":"success",
"files":["369dc61e-40c2-46c0-81f4-e31ca8c33cc2"]
}