API-Dokumentation für die el-Print-Software

Das Programm akzeptiert Druckdaten im JSON-Format.
Für die Kommunikation zwischen Ihrer Anwendung und el-Print wird das WebSocket-Protokoll verwendet.

API-URL: ws://host:port/ws

host – Domain oder IP-Adresse, die in der Programmkonfiguration angegeben ist.

port – Port, der in der Programmkonfiguration angegeben ist.

JSON-Struktur:

Request

{
"data": "...",
"category": "*",
"ext": "*",
"queue_end": "1"
}

data – Daten, die an den Drucker gesendet werden. Die Daten müssen base64-codiert sein. Optionaler Parameter.

category – eine Kategorie von Dokumenten. Der Datentyp ist eine Zeichenkette. Erlaubt sind Buchstaben und Ziffern, Unterstrich (_) und Bindestrich (-). Optionaler Parameter. Weitere Informationen finden Sie auf der Konfigurationsseite des Programms.

ext – ext steht für File Extension. Die Dateierweiterung besteht in der Regel aus 2–4 alphanumerischen Zeichen. Optionaler Parameter. Weitere Details finden Sie auf der Konfigurationsseite.

queue_end – dieser Parameter signalisiert das Ende der Druckwarteschlange. Hat er den Wert "1", schließt das Programm die WebSocket-Verbindung. Optionaler Parameter.

Response

{
"Status": "...",
"Message": "...",
}

Status – kann einen von zwei Werten annehmen: success oder error.

Message – eine Beschreibung des Antwortstatus.