Zum Inhalt springen
PenBlitz
← Entwickler

API: Vorlagen und Dokumente

Das Format eines Dokuments und wie man es als Vorlage speichert und wiederverwendet.

Vorlagen

  • GET /api/v1/templates listet alle Vorlagen, GET /api/v1/templates/{id} liefert eine.
  • PUT /api/v1/templates/{id} speichert eine Vorlage und legt sie bei Bedarf an.
  • GET /api/v1/templates/{id}/variables listet die Platzhalter einer Vorlage.
  • Mitgeliefert: letter, card, postcard, envelope-dl, voucher-qr und calibration.

Ein Dokument

Ein Dokument besteht aus einer Seite, Einstellungen zur Handschrift und einer Liste von Blöcken. Alle Maße sind Millimeter. Alles außer den Blöcken ist optional.

{
  "name": "Danke",
  "page": { "width_mm": 210, "height_mm": 297,
            "margin_left": 22, "margin_right": 22, "margin_top": 26, "margin_bottom": 22 },
  "humanize": { "enabled": true, "intensity": 1.0, "page_offset_jitter_mm": 1.0 },
  "blocks": [
    { "type": "text", "text": "Liebe {{vorname}},\n\nvielen Dank!", "font": "cursive", "size_mm": 5.5 },
    { "type": "spacer", "height_mm": 6 },
    { "type": "qr", "data": "https://shop.example/?c={{code|url}}", "module_mm": 1.5, "ec": "l",
      "caption": "{{code}}" }
  ]
}

Blöcke

Text-, QR- und SVG-Blöcke folgen untereinander. Mit x_mm und y_mm wird ein Block an eine Position geheftet; ein Textblock nimmt zusätzlich width_mm für seine Spalte.

TypFelder
texttext, font (cursive, script, block, gothic), size_mm, line_height, paragraph_gap, letter_spacing_mm, word_spacing, align, mix_fonts, shrink_to_fit
qrdata, module_mm, ec (l, m, q, h), align, caption, caption_size_mm
svgsvg (der SVG-Text), width_mm, align, variants (weitere Fassungen, je Blatt wird eine gewählt)
linex1_mm, y1_mm, x2_mm, y2_mm
spacerheight_mm

Regeln für die Seite

  • Außerhalb der Seitenränder darf nichts geschrieben werden; ein solches Blatt bekommt eine Warnung.
  • Auf Karten und Standardbriefen hält postal_zones das Briefmarkenfeld, die unteren 15 mm und den rechten Rand frei. Für Karten, die nicht verschickt werden, auf false setzen.
  • rotate dreht die fertige Seite um 0, 90, 180 oder 270 Grad, für Geräte, die quer einziehen.