API-Referenz

Diese Referenz dokumentiert die freigegebenen Endpunkte der eBOnaut API, gruppiert nach Bereichen.

Konventionen im Überblick

Thema	Kurzfassung	Details
Basis-URL	https://api.ebonaut.io (Prod) / https://api.dev.ebonaut.io (Dev)	Erste Schritte
Methoden	GET, POST	Anfragen
Authentifizierung	HMAC-signierter Request-Umschlag (hmac_ID, message, hmac)	Authentifizierung
Origin-Pflicht	Freigegebener Origin-Header nötig	Authentifizierung
Fehlerformat	{"message": "..."}	Fehler & Statuscodes
Rate Limit	250 Requests/s pro IP	Fehler & Statuscodes

Bereiche

Codesetup

Kunden-Onboarding (Pairing): codesetup/set erzeugt einen Setup-Code samt Aktivierungs-URL, codesetup/get liefert nach der Freischaltung durch die Kund:in einmalig die individuellen HMAC-Zugangsdaten. Beide Endpunkte werden mit den Partner-HMAC-Zugangsdaten signiert.

User

Abruf des eigenen Benutzerdatensatzes – im Kontext der jeweiligen Kund:in.

Select

Abruf von Auswahllisten – sowohl die systemseitigen Listen als auch selbst angelegte Felddefinitionen. selectgroup/getall liefert die verfügbaren Listen-Keys, select/getall/{key} die Einträge einer Liste.

Postboxitem

Verwaltung der Postbox-Items (Nachrichten): Items anlegen, abrufen, aktualisieren und löschen, per Typesense-Suche filtern, versenden, Empfangsbestätigungen senden, Status und Lese-Status setzen, History exportieren und Dateien als ZIP laden.

File

Dateiverwaltung: zweistufiger Upload (Registrierung per file/set, anschließender Upload an den separaten Datei-Service), Downloads mit kurzlebigen URLs, Metadaten lesen und Dateien löschen.

Datahandler

Abruf asynchroner Prozess-Ergebnisse: Endpunkte wie cert/setrequest oder contact/extendsearch liefern eine datahandler_ID, das Ergebnis wird per datahandler/get einmalig abgeholt.

Contact

Kontakte durchsuchen und abrufen: Volltextsuche über die eigenen Kontakte, Lookup per Justiz-ID sowie erweiterte Suche über das aktive Unternehmenszertifikat (asynchrones Ergebnis).

Cert

Verwaltung der Unternehmenszertifikate: Zertifikate abrufen, neue per Queue-Prozess anfordern, vorhandene hinterlegen, die automatische Synchronisation steuern und Zertifikate löschen.

HMAC

Verwaltung der HMAC-Zugangsdaten – derzeit das unwiderrufliche Löschen eines HMAC-Keys (danach ist der Zugang sofort gesperrt).

Allgemein

Allgemeine Endpunkte ohne fachliche Zuordnung – aktuell der öffentliche Health-Check /status.