Zum Inhalt springen

API-Referenz

Einstieg in die OmniOmni-Partner-APIs: Authentifizierung, Proof of Action, Umgebungen und Konventionen

PartnersystemOmniOmni API1 · Client-Sign-in2 · Bearer-TokenAPI-AnfrageAuthorization: BearerAntwortJSON · status · code3 · API-Anfrage4 · AntwortSensible Aktion?Proof-of-Action-SignaturX-SignatureX-Signature-DateTimeX-Signature-DeviceIdIdempotenzschlüssel
Partner-API: Client-Sign-in, Bearer-Token, signierte sensible Aufrufe

Die OmniOmni-Partner-APIs stellen lizenzierten Partnern und Integratoren die Register-, Verwahrungs- und Compliance-Funktionen des Ökosystems bereit. Diese Referenz gruppiert die interaktiven Operationsseiten nach Produkt. Konzeptionelle Leitfäden (Integrationsszenarien, Onboarding, Nutzungshinweise) finden Sie in den Produktbereichen.

Konventionen

ThemaKonvention
AuthentifizierungBearer-Token (JWT) aus dem Client-Sign-in des jeweiligen Produkts; Accept-Language wird bei jedem Aufruf erwartet. Siehe Client-Onboarding.
Sensible AktionenSigniert über den Proof-of-Action-Mechanismus: Header X-Signature, X-Signature-DateTime und X-Signature-DeviceId, RS256-Signatur mit dem privaten Schlüssel des handelnden Nutzers. Siehe Proof of Action.
IdempotenzNicht-GET-Methoden steuern Idempotenz über eindeutige Kennungen; einige Schreiboperationen akzeptieren X-Idempotency-Key. Siehe Hinweise zur API-Nutzung.
Rate-LimitsSandbox: begrenzte Anzahl von Nicht-GET-Anfragen je Zeitfenster; bei Überschreitung 429 Too Many Requests.
FehlerHTTP-Statuscode plus JSON-Body mit Status, fehlerspezifischem Code und beschreibender Meldung.
UmgebungenSandbox-Hosts stehen im Playground jeder Operation; Produktionsendpunkte werden beim Onboarding bereitgestellt.

Den Playground nutzen

Operation wählen

Öffnen Sie eine Operationsseite in der Seitenleiste. Der Playground zeigt Server, Pfad, Parameter und Antwortschema.

Autorisieren

Fügen Sie ein Bearer-Token aus dem Client-Sign-in des Produkts ein.

Gegen die Sandbox senden

Anfragen laufen über den Dokumentations-Proxy gegen die Sandbox-Umgebung. Verwenden Sie hier keine Produktionszugangsdaten.

Die Operationsseiten sind auf Englisch verfügbar. Deutsche Navigationsbezeichnungen werden bereitgestellt; der Inhalt der Operationen selbst ist nicht übersetzt.