Zum Inhalt springen

Guide · curl

PDFs aus einer CSV erzeugen mit curl

Eine Liste von Personen und eine Vorlage ergeben einen Stapel Dokumente. Statt einer Anfrage je Zeile reiht ein Batch bis zu 1.000 Renderings als einen Job ein, und es kommt ein Zip zurück. Dieses curl-Programm liest eine CSV, bildet die Zeilen ab und wartet auf den Job.

Kostenloser Plan mit 100 Einheiten im Monat, keine Kreditkarte

Was Sie brauchen

  • Einen API-Key. Legen Sie ihn in der App unter API-Schlüssel an und exportieren Sie ihn als FORMFEED_API_KEY. Zum Ausprobieren ist ein Test-Key (ff_test_…) richtig. Siehe Quickstart.
  • curl. Sie brauchen curl und jq.
  • Die Vorlage. certificate aus dem Zertifikats-Beispiel, deren Felder genau die Spalten der CSV sind.
  • Die CSV. attendees.csv neben dem Programm, mit Kopfzeile. Sie steht weiter unten.
  • Genug Einheiten. Batches gehören zu jedem Tarif, und jeder Eintrag zählt mindestens als eine Einheit. Im Free-Tarif wird ein Live-Batch abgelehnt, wenn im Monat weniger Einheiten übrig sind, als der Batch Einträge hat; ein Test-Schlüssel wird nicht gezählt. Die Limits-Seite nennt die Einheiten je Tarif.

Das Programm

Das Programm liest die CSV, macht aus jeder Zeile einen Eintrag, reiht sie mit zip: true als einen Job ein, wartet, bis der Job fertig ist, und speichert das Archiv.

batch.shShell
set -e

# jq builds one item per data row; -R reads the file as lines, -n lets it start from inputs
queued=$(jq -Rn '
      [inputs | split(",")] as $rows
      | { template: "certificate", zip: true,
          items: $rows[1:] | map({ data: { name: .[0], course: .[1], completed_on: .[2], hours: (.[3] | tonumber) } }) }
    ' attendees.csv \
  | curl -sS https://api-eu.formfeed.dev/v1/renders/batch \
      -H "Authorization: Bearer $FORMFEED_API_KEY" \
      -H "Content-Type: application/json" \
      --data-binary @-)

# every error is a problem document (RFC 9457) with a title and a detail
job=$(printf '%s' "$queued" | jq -r '.id // error(.title + ": " + (.detail // ""))')
printf '%s' "$queued" | jq -r '"\(.id) \(.total) queued"'

# the job is always asynchronous: ask for it until it is no longer queued or processing
while :; do
  sleep 2
  answer=$(curl -sS https://api-eu.formfeed.dev/v1/jobs/$job -H "Authorization: Bearer $FORMFEED_API_KEY")
  status=$(printf '%s' "$answer" | jq -r .status)
  case $status in queued | processing) ;; *) break ;; esac
done
printf '%s' "$answer" | jq -r '"\(.succeeded)/\(.total) rendered, \(.failed) failed"'

zip=$(printf '%s' "$answer" | jq -r '.zip_url // empty')
if [ -n "$zip" ]; then curl -sS -o certificates.zip "$zip"; fi

Ausführen

Es gibt die Job-ID und die Zahl der eingereihten Renderings aus, dann 4/4 rendered, 0 failed, und certificates.zip liegt neben dem Programm, mit einem PDF je Zeile, 0001-document.pdf bis 0004-document.pdf.

Shell
export FORMFEED_API_KEY=ff_test_...
sh batch.sh

Was an curl besonders ist

  • jq schreibt das JSON. Weil jq den Body baut und keine String-Verkettung, werden Anführungszeichen, Zeilenumbrüche und Umlaute in der Eingabe korrekt maskiert.
  • Fehler verschwinden nicht. error(…) lässt jq mit Titel und Detail des Problems abbrechen, wenn die Antwort ein Problem-Dokument ist, und set -e beendet das Skript dort, statt dem nächsten Befehl einen leeren String zu geben.
  • Der Schlüssel geht nur an die API. Jeder Aufruf der API trägt den Authorization-Header. Die Datei kommt von einer signierten URL, die keinen braucht, also holt das letzte curl sie ohne Ihren Schlüssel.

Die CSV

Eine Kopfzeile, eine Zeile je Dokument. Die Spalten sind die Felder, die die Vorlage erwartet, eine Zuordnungstabelle braucht es also nicht:

attendees.csvText
name,course,completed_on,hours
Erika Mustermann,Analytical Engines 101,2026-09-10,16
Max Mustermann,Analytical Engines 101,2026-09-10,16
Jane Doe,Print CSS for developers,2026-09-11,8
John Doe,Print CSS for developers,2026-09-11,8

Was ein Batch anders macht

  • Immer asynchron. Die Antwort kommt sofort mit dem Status queued. Die Renderings laufen im Hintergrund, so viele gleichzeitig, wie Ihr Tarif erlaubt.
  • Eine Vorlage, viele Einträge. Ein template auf oberster Ebene gilt für jeden Eintrag, der keine eigene nennt; ein Eintrag besteht deshalb meist nur aus seinen data.
  • Teilweise gescheitert ist ein Zustand. Ein Job, in dem einige Einträge gescheitert sind, endet als partially_failed (failed, wenn alle gescheitert sind). succeeded und failed zählen sie, und jeder Eintrag ist in items ein eigenes Rendering mit eigenem Fehler.
  • Das Zip ist optional. Jeder Eintrag behält in items seine eigene Download-URL, und das wollen Sie, wenn die Dokumente an verschiedene Personen gehen. zip: true legt die geglückten zusätzlich in ein Archiv, jedes benannt mit 0001- und dem filename seines Eintrags (document.pdf ohne einen), in der Reihenfolge der Zeilen.
  • Oder ein Webhook. Statt zu warten, geben Sie dem Batch eine webhook_url und lassen sich von job.completed benachrichtigen (oder von job.failed, wenn alle Einträge gescheitert sind). Für tausende Dokumente ist das die bessere Form: kein Prozess, der minutenlang wartet.

Wenn die API nein sagt

  • Eine Form für jeden Fehler. Fehler sind Problem-Dokumente (RFC 9457) mit type, title, status, detail, einem stabilen code und der request_id, die Sie dem Support nennen; die type-URL führt zu einer Seite über diesen Fehler. Die Liste steht in der Fehlerreferenz.
  • Die üblichen. 401 unauthorized bei fehlendem oder widerrufenem Schlüssel, 404 template_not_found bei falschem Vorlagennamen, 422 template_runtime_error, wenn die Vorlage an den Daten scheitert, 429 rate_limited über den Anfragen pro Sekunde des Tarifs, 402 quota_exceeded, wenn die Einheiten des Free-Tarifs verbraucht sind (ein bezahlter Tarif rechnet weitere Einheiten ab, bis zu seiner Obergrenze).
  • Sicher wiederholen. Senden Sie beim POST einen Idempotency-Key-Header und wiederholen Sie die Anfrage mit demselben Schlüssel, wenn Sie nicht wissen, ob der erste Versuch ankam: 24 Stunden lang liefert der Schlüssel die erste Antwort, statt erneut zu rendern und zu berechnen. Gespeichert wird die Antwort, sobald der erste Versuch beantwortet ist; wiederholen Sie also nicht, solange er noch laufen kann. Auch Probleme unter 500 werden gespeichert, eine korrigierte Anfrage braucht deshalb einen neuen Schlüssel.

Die Aufgabe um dieses Programm

Dieser Guide ist ein Programm. Was die Aufgabe darum herum braucht, von der Vorlage bis zu Limits und Preis, steht auf der Seite Zertifikate per API erzeugen.

Weitere Guides für curl

FAQ

Wie viele Zeilen darf ein Job haben?
Bis zu 1.000 Einträge je Batch. Teilen Sie eine längere Liste auf mehrere Jobs auf; wie viele Jobs Sie starten, ist nicht begrenzt, und jeder zählt einmal gegen das Rate Limit. Siehe Async und Batch.
Was passiert, wenn eine Zeile falsch ist?
Scheitert die Vorlage an den Daten einer Zeile, scheitert dieser Eintrag, und die anderen rendern trotzdem: Der Job endet als partially_failed, und der gescheiterte Eintrag trägt den Fehler; Sie können die Zeile korrigieren und einzeln erneut rendern. Ein Eintrag, den die API von vornherein ablehnt (ein Feld der Anfrage, das sie nicht annimmt, oder Daten, die mit validate_data nicht zum Schema der Vorlage passen), lässt den ganzen Batch scheitern, bevor etwas eingereiht wird, und das Problem nennt seine Position.
Kostet ein gescheiterter Eintrag Einheiten?
Nein. Gezählt wird nur, was entstanden ist.
Geht das auch ohne Code, mit einer Tabelle?
Ja: Die App nimmt eine CSV- oder Excel-Datei, ordnet die Spalten den Feldern der Vorlage zu und führt den Batch aus. Der Code hier ist dasselbe innerhalb Ihres eigenen Systems.

Batch aus einer CSV in anderen Sprachen

Heute mit dem Rendern beginnen

Der kostenlose Plan enthält 100 Einheiten im Monat und kostenlose Testrenderings. Wechseln Sie den Plan, wenn Sie mehr brauchen.