Zum Inhalt springen

Guide · Node.js (TypeScript)

PDFs aus einer CSV erzeugen mit Node.js (TypeScript)

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 Node.js (TypeScript)-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.
  • Node.js (TypeScript). Sie brauchen Node.js 22 oder neuer und das Paket @formfeed/sdk, das selbst keine Abhängigkeiten hat.
  • 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.
InstallierenShell
npm install @formfeed/sdk
npm install --save-dev tsx   # führt die .ts-Datei direkt aus

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.tsTypeScript
import { readFile, writeFile } from 'node:fs/promises';
import { Formfeed } from '@formfeed/sdk';

const formfeed = new Formfeed({ apiKey: process.env.FORMFEED_API_KEY! });

// a simple CSV: one line per attendee, no quoted fields. For anything else use a parser (csv-parse).
const [header, ...rows] = (await readFile('attendees.csv', 'utf8')).trim().split(/\r?\n/);
const columns = header!.split(',');
const attendees = rows.map((row) => Object.fromEntries(row.split(',').map((value, i) => [columns[i]!, value])));

const job = await formfeed.renders.batch({
  template: 'certificate',
  zip: true,
  // every field of a CSV is text: the template expects hours as a number
  items: attendees.map((a) => ({ data: { ...a, hours: Number(a['hours']) } })),
});
console.log(job.id, job.total, 'queued');

// polls GET /jobs/{id} until the job is done, with backoff and a timeout
const done = await formfeed.jobs.waitFor(job.id);
console.log(`${done.succeeded}/${done.total} rendered, ${done.failed} failed`);

if (done.zip_url) await writeFile('certificates.zip', new Uint8Array(await (await fetch(done.zip_url)).arrayBuffer()));

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_...
npx tsx batch.ts

Was an Node.js (TypeScript) besonders ist

  • Top-Level-await. Die Datei verwendet await außerhalb einer Funktion, sie muss also ein ES-Modul sein: "type": "module" in der package.json oder die Endung .mts.
  • Retries sind eingebaut. Das SDK sendet mit jedem Rendering einen Idempotency-Key und wiederholt 429, 503 und Netzwerkfehler bis zu dreimal mit Backoff, mit demselben Schlüssel: Ein Retry einer Anfrage, die schon beantwortet wurde, erhält diese Antwort zurück statt eines zweiten Renderings.
  • Typisierte Fehler. Eine Problem-Antwort wirft einen FormfeedError, dessen code der Fehlercode der API ist (template_not_found, quota_exceeded, …); fangen Sie ihn dort, wo Sie dem Nutzer etwas Sinnvolles zeigen können.
  • Läuft überall, wo es fetch gibt. Das SDK nutzt nur Web-APIs, derselbe Aufruf funktioniert also in Deno, Bun und Cloudflare Workers; nur der Dateizugriff ist anders.

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 Node.js (TypeScript)

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.