Zum Inhalt springen

Guide · Go

PDF-Rechnung aus JSON erzeugen mit Go

Ihr Go-Code sendet die Fakten einer Rechnung (Kunde, Positionen, Steuersatz) und erhält ein fertiges PDF zurück. Summen, Zahlenformate, Fälligkeit und der QR-Code für die Zahlung sind Sache der Vorlage; nichts von dieser Logik landet in Ihrer Anwendung.

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.
  • Go. Sie brauchen Go 1.21 oder neuer; das Programm nutzt nur die Standardbibliothek.
  • Die Vorlage. invoice-de aus dem Rechnungsbeispiel: Kopieren Sie es von der Seite des Beispiels in Ihren Workspace; die Kopie behält den Namen invoice-de und ist veröffentlicht. Oder pushen Sie den Ordner mit der CLI (formfeed templates push --publish). Ein Rendering nutzt die veröffentlichte Version.
  • Die Daten. Die data.json des Beispiels neben dem Programm. Sie enthält Firma, Kunde und zwei Positionen, aber keine Summen.

Das Programm

Das Programm liest data.json, sendet sie mit dem Namen der Vorlage und einem Dateinamen aus der Rechnungsnummer, wartet auf das Ergebnis, wenn die API mit 202 antwortet, bricht mit der Meldung der API ab, wenn etwas nicht stimmt, und speichert das PDF.

main.goGo
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"os"
	"time"
)

const endpoint = "https://api-eu.formfeed.dev/v1/renders"

// a render or a problem document: both are JSON objects, so one struct decodes either
type render struct {
	ID          string  `json:"id"`
	Status      string  `json:"status"`
	DownloadURL string  `json:"download_url"`
	PageCount   int     `json:"page_count"`
	Units       float64 `json:"units"`
	Title       string  `json:"title"`
	Detail      string  `json:"detail"`
}

// send makes one call with the key and decodes the answer
func send(method, url string, body []byte) (int, render) {
	request, _ := http.NewRequest(method, url, bytes.NewReader(body))
	request.Header.Set("Authorization", "Bearer "+os.Getenv("FORMFEED_API_KEY"))
	request.Header.Set("Content-Type", "application/json")
	response, err := http.DefaultClient.Do(request)
	if err != nil {
		panic(err)
	}
	defer response.Body.Close()
	var answer render
	json.NewDecoder(response.Body).Decode(&answer)
	return response.StatusCode, answer
}

func main() {
	data, err := os.ReadFile("data.json")
	if err != nil {
		panic(err)
	}
	// the file name carries a value of the data, so that one value is decoded
	var parsed struct {
		Invoice struct {
			Number string `json:"number"`
		} `json:"invoice"`
	}
	if err := json.Unmarshal(data, &parsed); err != nil {
		panic(err)
	}
	body, _ := json.Marshal(map[string]any{
		"template": "invoice-de",
		"data":     json.RawMessage(data),
		"filename": "invoice-" + parsed.Invoice.Number + ".pdf",
	})

	status, result := send("POST", endpoint, body)
	// not done within 60 seconds: the answer is 202 and the render goes on in the background;
	// its result answers the same way until the render has finished
	for status == http.StatusAccepted {
		time.Sleep(2 * time.Second)
		status, result = send("GET", endpoint+"/"+result.ID+"/result", nil)
	}
	// every error is a problem document (RFC 9457) with a title and a detail
	if status >= 400 {
		fmt.Fprintf(os.Stderr, "%s: %s\n", result.Title, result.Detail)
		os.Exit(1)
	}

	file, err := http.Get(result.DownloadURL)
	if err != nil {
		panic(err)
	}
	defer file.Body.Close()
	out, _ := os.Create("invoice.pdf")
	defer out.Close()
	io.Copy(out, file.Body)
	fmt.Printf("%s %d page(s), %v unit(s)\n", result.ID, result.PageCount, result.Units)
}

Ausführen

Es gibt die ID des Renderings, die Seitenzahl und die verbrauchten Einheiten aus, und invoice.pdf liegt neben dem Programm. Mit einem Schlüssel, der mit ff_test_ beginnt, wird das Rendering nicht gezählt; im Free-Tarif trägt es ein kleines Wasserzeichen.

Shell
export FORMFEED_API_KEY=ff_test_...
go run main.go

Was an Go besonders ist

  • json.RawMessage. Die Beispieldaten gehen so in den Body, wie sie auf der Platte liegen, ohne vorher in Go-Typen dekodiert zu werden; das Programm funktioniert deshalb für jede Vorlage.
  • Ein Struct für beide Antworten. Ein Rendering und ein Problem-Dokument sind beide JSON-Objekte, ein einziges Struct mit title und detail neben den Render-Feldern dekodiert also beides.
  • Timeouts. http.DefaultClient hat keinen. Geben Sie dem Client in einem Dienst einen Timeout etwas über 60 Sekunden: Ein synchrones Rendering antwortet, wenn die Datei fertig ist, oder nach 60 Sekunden mit 202, während es im Hintergrund weiterläuft.

Was die Vorlage mit dem JSON macht

Die Anfrage enthält keine abgeleiteten Zahlen, und genau das ist der Sinn des Renderns aus einer Vorlage:

  • Summen. invoice.lines | sum('total') addiert die Positionen, Umsatzsteuer und Brutto ergeben sich aus invoice.vat_rate.
  • Formate. Mit der Locale de-DE der Vorlage gibt money 3.760,40 € aus und date('dd.MM.yyyy') 10.09.2026; dateAdd(14, 'days') setzt die Fälligkeit.
  • GiroCode. epcQr zeichnet den SEPA-Zahlungscode aus Name, IBAN, BIC, Betrag und Verwendungszweck.
  • Dateiname. ist nicht Sache der Vorlage. Die API übernimmt filename, wie er ist, und füllt keine Vorlagen-Ausdrücke, deshalb baut das Programm invoice-2026-0042.pdf aus der Rechnungsnummer, und der Download trägt diesen Namen. Zeichen außer A–Z, a–z, 0–9, ., -, _, (, ) und dem Leerzeichen werden zu _, Umlaute also auch.

Von einer Rechnung zu vielen

Ein Rechnungslauf ist ein Batch: eine Anfrage mit bis zu 1.000 Dokumenten, am Ende ein Zip und ein Webhook, wenn alles fertig ist. Siehe Batches. Dokumente, die länger als ein paar Sekunden brauchen, rendern Sie asynchron und lassen sich per Webhook benachrichtigen.

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 Rechnungs-PDF-API.

Weitere Guides für Go

FAQ

Kann ich das Rechnungs-HTML senden, statt eine gespeicherte Vorlage zu nutzen?
Ja, setzen Sie es in html und lassen Sie template weg; der HTML-zu-PDF-Guide dieser Sprache zeigt es. Eine gespeicherte Vorlage bringt Versionen, eine Vorschau mit Ihren Beispieldaten und Release Channels.
Wie lange gilt die Download-URL?
Ein signierter Link gilt höchstens sieben Tage und nie länger, als die Datei aufbewahrt wird; darüber entscheidet die Aufbewahrung Ihres Tarifs (eine Einstellung des Workspace oder expires_in kann sie nur verkürzen). GET /renders/{id} stellt jederzeit einen frischen Link aus, speichern Sie also die ID des Renderings, nicht die URL. Mit access: "public" gilt der Link so lange wie die Datei. Details in der Rendering-Doku.
Was kostet ein Rendering?
Eine Einheit je angefangene fünf Seiten eines PDFs, also eine für eine bis fünf Seiten und zwei für sechs bis zehn. Test-Renderings sind kostenlos. Siehe Preise.

PDF-Rechnung aus JSON 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.