Zum Inhalt springen
PenBlitz
← Entwickler

API: Aufträge und Seriendruck

Druckaufträge aus Vorlagen und Daten anlegen, ihren Fortschritt verfolgen und die Warteschlange steuern.

Einen Auftrag anlegen

POST /api/v1/jobs nimmt entgegen, was gedruckt werden soll, und die Daten dazu. Jeder Datensatz ergibt ein Blatt.

FeldBedeutung
template_idID einer gespeicherten Vorlage. Alternativ ein vollständiges Dokument senden.
documentEin ganzes Dokument als JSON, statt einer Vorlage.
recordsListe von Objekten mit den Platzhalterwerten, eines pro Blatt.
csvDieselben Daten als CSV- oder JSON-Text, statt records.
copiesExemplare je Datensatz. Vorgabe 1.
additional_template_idsVorlagen, die für jeden Datensatz nach der Hauptvorlage gedruckt werden, z. B. der Umschlag.
scheduled_atNicht vor diesem Zeitpunkt beginnen (ISO 8601).
confirm_each_pageNach jedem Blatt warten, bis der Auftrag fortgesetzt wird (Handeinzug).
strictAuftrag ablehnen, wenn ein Platzhalter keinen Wert hat.
strict_layoutAuftrag ablehnen, wenn ein Blatt außerhalb der Ränder oder in eine Post-Zone schreibt.
holdAuftrag pausiert anlegen; er wartet in der App auf Freigabe.
callback_urlAdresse, die benachrichtigt wird, wenn der Auftrag beendet ist.
seedFeste Handschrift-Variante; ohne Angabe zufällig.
curl -X POST http://127.0.0.1:8787/api/v1/jobs \
  -H 'Content-Type: application/json' \
  -d '{
    "template_id": "voucher-qr",
    "csv": "salutation;code\nFrau Schmidt;FHE93KL\nHerr Meier;KQ7X2MB",
    "strict": true
  }'

Einen Auftrag verfolgen

GET /api/v1/jobs/{id} liefert den Auftrag mit jeder Seite. Der Zustand ist einer von:

ZustandBedeutung
scheduledWartet auf seine Startzeit.
queuedWartet auf den Drucker.
printingEin Blatt wird geschrieben.
pausedVon einem Menschen pausiert oder wartet auf Freigabe.
waiting_for_paperWartet, bis das nächste Blatt eingelegt und bestätigt ist.
doneAlle Blätter geschrieben.
failedEin Blatt ist fehlgeschlagen; das Feld error nennt den Grund.
canceledAbgebrochen.

Steuern

  • POST /api/v1/jobs/{id}/pause, /resume und /cancel wirken auf einen Auftrag.
  • Resume bestätigt auch einen Papierwechsel und druckt die restlichen Blätter eines fehlgeschlagenen Auftrags.
  • POST /api/v1/queue/pause und /resume halten die ganze Warteschlange an und geben sie frei.
  • GET /api/v1/jobs/{id}/pages/{page}/preview.svg liefert das Bild eines Blatts (Seitenzählung beginnt bei 0).

Warnungen

Jede Seite eines Auftrags trägt ihre Warnungen: ein Platzhalter ohne Wert, Text außerhalb der Ränder, ein QR-Code, der für den Stift zu klein ist. Lies sie vor einer großen Serie, oder sende strict und strict_layout, damit ein solcher Auftrag abgelehnt wird.