Über die API senden
Alles im Produkt ist über eine REST-API verfügbar. Verdrahten Sie transaktionale Versände (Bestellbestätigungen, Passwort-Resets, Alerts) einmal in Ihrem Backend und abonnieren Sie dann Webhooks für Zustellungs- und Engagement-Ereignisse.
Was Sie brauchen
- Eine verifizierte Versanddomain
- Admin-Zugang zum Erstellen eines API-Keys
- Ein Backend, das HTTPS-Anfragen stellen kann
API-Key erstellen
- 1
Einstellungen → API-Keys → „Erstellen“ öffnen
Stellen Sie einen Key aus, der genau auf das Nötige beschränkt ist (z. B. messages:send), mit einem Rate-Limit und einer optionalen IP-Allowlist, damit ein geleakter Key nicht missbraucht werden kann.
- 2
Key einmalig kopieren
Der vollständige Key (sb_live_<prefix>.<secret>) wird nur bei der Erstellung angezeigt. Bewahren Sie ihn in Ihrem Secret-Manager auf — er kann nicht erneut abgerufen werden.
Authentifizieren
Jede Anfrage verwendet ein Bearer-Token. Die Basis-URL ist https://api.climails.com/v1.
Authorization: Bearer sb_live_<prefix>.<secret>Nachricht senden
POST an /v1/messages mit einem Kanal, einem Empfänger und entweder einer template_id (+ Variablen) oder einem rohen subject/html. Übergeben Sie einen Idempotency-Key, damit eine wiederholte Anfrage nie zweimal sendet.
curl https://api.climails.com/v1/messages \
-H "Authorization: Bearer sb_live_<prefix>.<secret>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order-1042" \
-d '{
"channel": "email",
"to": "[email protected]",
"from_email": "[email protected]",
"subject": "Your order is confirmed",
"html": "<p>Hi Ann, your order #1042 is on its way.</p>"
}'Im Browser ausprobieren
Öffnen Sie Einstellungen → API & Playground, um die interaktive RapiDoc-Konsole zu nutzen: Fügen Sie Ihren Key unter „Authenticate“ ein und stellen Sie echte Anfragen, bevor Sie eine Zeile Code schreiben. Dieselbe Referenz ist öffentlich unter /docs verfügbar, die rohe OpenAPI-Spezifikation unter /openapi.yaml.
Webhooks abonnieren
Registrieren Sie einen Webhook (Einstellungen → Webhooks oder POST /v1/workspaces/{workspace_id}/webhooks), um delivered-, bounce-, complaint-, open- und click-Ereignisse zu empfangen, damit Ihre App auf das reagiert, was nach dem Versand passiert.
- Workspace-bezogene Ressourcen liegen unter /v1/workspaces/{workspace_id}/… — Ihre workspace_id erhalten Sie über GET /v1/workspaces.
- Verifizieren Sie die Webhook-Signatur mit dem Secret, das beim Erstellen angezeigt wird.
Häufig gestellte Fragen
Was ist der Unterschied zwischen transaktionalen und Kampagnenversänden?
Transaktional = eine Nachricht an eine Person, ausgelöst durch Ihre App (POST /v1/messages). Kampagnen sind Massenversände an Listen/Segmente, geplant über das Cabinet oder die Kampagnen-API.
Wie funktioniert Idempotenz?
Senden Sie einen Idempotency-Key-Header; eine Wiederholung innerhalb von 24 Stunden liefert das ursprüngliche Ergebnis zurück, statt erneut zu senden.
Wo finde ich meine workspace_id?
Rufen Sie GET /v1/workspaces mit Ihrem Key auf — es listet den Workspace auf, zu dem der Key gehört.
In Minuten mit dem Versand starten
Kostenloses Konto erstellen, Domain verbinden und Ihre Zielgruppe über alle Kanäle erreichen – ohne Kreditkarte.
Dauerhaft kostenloser Tarif · Keine Kreditkarte · In Minuten startklar