Zählt das Bild als Rendering?

Ja, eine Einheit je Bild, wie ein einseitiges PDF. Test-Renderings sind kostenlos. Siehe Preise.

Kann ich eigene Schriften verwenden?

Ja: Verlinken Sie eine Webfont im Head der Vorlage, die der Renderer holt und cacht, oder laden Sie ab dem Starter-Tarif Schriftdateien in der App unter Schriften hoch und nennen Sie die Familie in Ihrem CSS. Siehe Schriften.

Warum ist mein Text abgeschnitten?

Der Rahmen ist fest, eine lange Überschrift muss also nachgeben. Das Beispiel kürzt mit truncate: 70; eine kleinere Schrift oder eine zweizeilige Begrenzung in CSS geht auch.

Guide · Node.js (TypeScript)

Open-Graph-Bilder erzeugen mit Node.js (TypeScript)

Jeder Beitrag braucht ein Vorschaubild, und von Hand gezeichnet skaliert das nicht. Dieses Node.js (TypeScript)-Programm sendet Titel, Kategorie und Autor an eine Vorlage und erhält ein PNG auf dem CDN zurück, fertig für das Meta-Tag og:image.

Kostenlos starten Dokumentation lesen

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. og-image aus dem Open-Graph-Beispiel: Tailwind-Klassen, beim Rendern kompiliert, kein Stylesheet zu pflegen.
Die Daten. Die data.json des Beispiels neben dem Programm: Kategorie, Titel, Veröffentlichungsdatum, Lesedauer und der Autor mit Avatar-URL.

InstallierenShell

npm install @formfeed/sdk
npm install --save-dev tsx   # führt die .ts-Datei direkt aus

Das Programm

Das Programm liest data.json, fordert png an, macht die Ausgabe öffentlich, wartet auf das Ergebnis, wenn die API mit 202 antwortet, und speichert das Bild; download_url ist seine Adresse auf dem CDN.

render.tsTypeScript

import { readFile, writeFile } from 'node:fs/promises';
import { Formfeed } from '@formfeed/sdk';

const formfeed = new Formfeed({ apiKey: process.env.FORMFEED_API_KEY! });
const data = JSON.parse(await readFile('data.json', 'utf8'));

// a problem answer (4xx, 5xx) throws a FormfeedError with the API's code, title and detail
let render = await formfeed.renders.create({
  template: 'og-image',
  data,
  output: 'png',
  access: 'public',
});
// not done within 60 seconds: the API answered 202 and the render goes on in the background
if (render.status !== 'succeeded') render = await formfeed.renders.waitFor(render.id);
if (render.status === 'failed') throw new Error(`render failed: ${JSON.stringify(render.error)}`);

await writeFile('og-image.png', await formfeed.renders.download(render));
console.log(render.id, render.download_url);

Ausführen

Es gibt die ID des Renderings und die Download-URL aus, und og-image.png liegt neben dem Programm. Öffnen Sie es: 1200 × 630 Pixel, der Titel passend gekürzt, der Avatar rund.

Shell

export FORMFEED_API_KEY=ff_test_...
npx tsx render.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.

Was die beiden Optionen tun

output: "png". Nennt das Format des Bildes. jpg und webp gehen ebenso; Pixelmaß, Skalierungsfaktor und das Format einer Anfrage ohne output kommen aus den image-Einstellungen der Vorlage.
access: "public". Liefert eine CDN-URL ohne Signatur, und genau das braucht ein Meta-Tag: Ein Scraper hat keinen API-Schlüssel. Die Adresse funktioniert so lange, wie die Datei aufbewahrt wird, worüber die Aufbewahrung Ihres Plans entscheidet; liefern Sie das gespeicherte Bild also von Ihrer eigenen Website aus, wenn eine Seite länger geteilt wird. Nutzen Sie es nur für Bilder, die öffentlich sein dürfen.

Einmal rendern, nicht bei jedem Aufruf

Eine identische Anfrage mit einem Live-Schlüssel innerhalb von 24 Stunden kommt zum Nulltarif aus dem Deduplizierungs-Cache; ein zweiter Deploy am selben Tag kostet also nichts (Test-Schlüssel kosten ohnehin nichts und werden nie dedupliziert). Danach wird das Bild neu gerendert: Speichern Sie das Bild oder seine URL beim Beitrag und rendern Sie, wenn sich der Beitrag ändert, nie im Seiten-Handler, denn ein Social-Scraper wartet nicht auf ein Rendering. Siehe Deduplizierung.

Eine Vorlage, viele Größen

Open Graph will 1200 × 630, andere Netzwerke wollen andere Maße. Schreiben Sie die Größe in settings.image der Anfrage statt in die Vorlage, dann rendert dasselbe Markup jedes Format, das Sie brauchen.

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 Open-Graph-Bild-API.

Weitere Guides für Node.js (TypeScript)

FAQ

Zählt das Bild als Rendering?: Ja, eine Einheit je Bild, wie ein einseitiges PDF. Test-Renderings sind kostenlos. Siehe Preise.
Kann ich eigene Schriften verwenden?: Ja: Verlinken Sie eine Webfont im Head der Vorlage, die der Renderer holt und cacht, oder laden Sie ab dem Starter-Tarif Schriftdateien in der App unter Schriften hoch und nennen Sie die Familie in Ihrem CSS. Siehe Schriften.
Warum ist mein Text abgeschnitten?: Der Rahmen ist fest, eine lange Überschrift muss also nachgeben. Das Beispiel kürzt mit truncate: 70; eine kleinere Schrift oder eine zweizeilige Begrenzung in CSS geht auch.