Erste Schritte

Die eBOnaut API ist eine JSON-basierte HTTP-API für Server-zu-Server-Integrationen. Jeder Request wird per HMAC-Signatur authentifiziert. Diese Seite gibt dir den Überblick, der Schnellstart führt dich anschließend mit Code durch den kompletten Ablauf.

Basis-URLs

Umgebung	Basis-URL
Produktion	https://api.ebonaut.io
Entwicklung	https://api.dev.ebonaut.io

Alle Pfade in dieser Dokumentation sind relativ zur Basis-URL angegeben.

Das brauchst du

1. Partner-Zugangsdaten (hmac_ID, secret_key, encryption_key). Du bekommst sie von eBOnaut, wenn du Integrationspartner:in bist, siehe Zugang & Nutzungsregeln.
2. Einen freigegebenen Origin. Die API prüft den Origin-Header jeder Anfrage gegen eine Allowlist. Fehlt er oder ist er nicht freigegeben, antwortet sie mit 403.

Origin-Header nicht vergessen

Deine Integration läuft serverseitig, also musst du den Origin-Header bei jedem Request selbst mitsenden.

So läuft eine Integration ab

1. Kund:innen verbinden. Die Kund:in gibt die Verbindung über einen Code frei (Pairing). Du erhältst Zugangsdaten, die nur für diese Kund:in gelten. Details: Pairing-Ablauf.
2. Requests signieren. Jeder Request wird verschlüsselt und signiert in einen Umschlag verpackt. Details: Authentifizierung.
3. Endpunkte aufrufen. Mit den Kunden-Zugangsdaten nutzt du alle Bereiche der API-Referenz.

Der erste Request

Ein Request sieht so aus:

curl -X POST "https://api.ebonaut.io/contact/search" \
  -H "Origin: https://partner.example.com" \
  -F "hmac_ID=<hmac_id>" \
  -F "message=<iv_hex:verschluesselte_nachricht_hex>" \
  -F "hmac=<hmac_sha256_hex>"

Die Werte in spitzen Klammern entstehen durch Verschlüsselung und Signatur. Eine fertige Funktion dafür findest du im Schnellstart. Eine erfolgreiche Antwort hat den Status 200 und den Content-Type application/json.

Health-Check

Der Status-Endpunkt braucht keine Authentifizierung und eignet sich für Uptime-Monitoring:

curl "https://api.ebonaut.io/status"

Die Antwort ist OK mit Status 200.

Wie geht es weiter?

Du willst …	Dann lies …
direkt loslegen	Schnellstart
Kund:innen anbinden	Pairing-Ablauf
verstehen, wie Requests signiert werden	Authentifizierung
einen Begriff nachschlagen	Glossar