Integration · Entwickler

REST API.

Mit der REST API schickst du Briefe und Karten direkt aus deiner Software. Über Webhooks erfährst du, wann ein Brief versendet und wann ein QR-Code gescannt wurde.

Kostenloses Erstgespräch Zur API-Dokumentation

bash

curl -X POST https://api.briefheld.de/v1/orders \
  -H "x-api-key: DEIN_TEST_SCHLUESSEL" \
  -H "Content-Type: application/json" \
  -d '{
    "card": "Dankeskarte",
    "template": "Danke nach Kauf",
    "variables": { "produkt": "Kaffeemühle" },
    "recipient": {
      "first_name": "Lena", "last_name": "Weber",
      "street": "Hauptstraße 1", "zip": "42651", "city": "Solingen"
    },
    "is_test": true
  }'

Beispiele

Wenn das passiert, geht eine Karte raus.

Dein System legt einen Auftrag an
Dann: Ein POST, und der Brief wird geschrieben.
Brief ist versendet
Dann: Webhook „shipment.dispatched“ an deine Adresse.
QR-Code wird gescannt
Dann: Webhook „qr_code.scanned“ an deine Adresse.

Funktionen

Was mit REST API geht.

Aufträge mit Vorlage und Platzhaltern oder mit freiem Text
Absender, QR-Code mit eigener Ziel-URL und Beilagen pro Auftrag
Testmodus mit eigenen Test-Schlüsseln
Webhooks mit Signatur, automatische Wiederholung bei Fehlern
Interaktive Dokumentation mit allen Endpunkten

Stiftspitze des Schreibroboters schreibt mit Kugelschreiber

Einrichtung

In drei Schritten startklar.

Wir helfen dir dabei, im Erstgespräch oder direkt in der App.

1
API-Schlüssel erstellen
Schlüssel unter Integrationen in Briefheld anlegen, zuerst im Testmodus.
2
Ersten Auftrag senden
POST an /v1/orders mit Karte, Vorlage und Empfänger.
3
Webhook eintragen
Adresse hinterlegen und Ereignisse wie Versand und Scan empfangen.

Weitere Integrationen