​
Sandbox-Umgebung

Die SANDBOX-Umgebung wurde speziell dafür aufgesetzt, dass Sie die neuesten Funktionen in einer kontrollierten Umgebung erkunden, testen und nutzen können. Diese Umgebung ermöglicht es Kunden, unsere Lösung zu testen und sie in ihr eigenes System zu integrieren. Um auf unsere Sandbox-Umgebung zuzugreifen, siehe Kunden-Onboarding.

​
Ratenbegrenzungen

OmniOmni setzt Ratenbegrenzungen für die API durch, um sicherzustellen, dass keine einzelne Organisation zu viele Ressourcen verbraucht. Ratenbegrenzungen werden auf Organisationsebene angewendet und nicht auf API-Schlüssel. In der Sandbox-Umgebung gelten Ratenbegrenzungen für Nicht-GET-Endpunkte und sind auf 3000 Anfragen pro 10 Minuten festgelegt. Wird das Limit überschritten, gibt die API eine 429 Too Many Requests-Antwort zurück.

​
Idempotenz

Idempotenz bei REST-Aufrufen ist ein entscheidendes Prinzip, das sicherstellt, dass eine Anfrage wiederholt werden kann, ohne das Ergebnis zu verändern. Dies ist besonders wichtig in verteilten Systemen, in denen Netzwerkausfälle oder Zeitüberschreitungen dazu führen können, dass Anfragen erneut gesendet werden. Jede Nicht-GET-Methode in unserer API verwaltet die Idempotenz auf ihre eigene Weise, indem sie eindeutige Identifikatoren (wie E-Mail, Transfer-Schlüssel usw.) verwendet. Wir stellen sicher, dass Anfragen nicht mehrfach auf dem Server verarbeitet werden, und wenn die Daten bereits vorhanden sind, wird die Antwort aus den bestehenden Daten generiert.

​
Fehlerbehandlung

Im Falle eines Fehlers enthält unsere API-Antwort nicht nur den standardmäßigen HTTP-Statuscode, sondern auch ein detailliertes JSON-Objekt. Dieses JSON-Objekt enthält den HTTP-Status, einen fehlerbezogenen Code und eine beschreibende Nachricht, die zusätzlichen Kontext über den Serverfehler bietet. Dieser Ansatz hilft den Kunden, die Art des Fehlers leicht zu verstehen und entsprechende Maßnahmen zu ergreifen.