bimetricsEntwickler

Stabilität und Änderungen

Welche Teile der API dokumentiert sind und worauf deine Integration achten sollte.

Als Markdown ansehen

Dokumentierter Umfang

Dokumentiert sind die hier beschriebenen Felder und Filterattribute. Antworten können weitere Felder enthalten, die sich ohne Ankündigung ändern können.

Zur Dokumentation gehören:

  • die Endpunkte der Referenz mit ihren Berechtigungen und den dort beschriebenen Feldern in Anfragen und Antworten,
  • die Filterattribute je Route, in sort nur die als sortierbar markierten,
  • das Fehlerformat mit code und status.

Hinweise für deine Integration

  • Nicht dokumentierte Felder: Verwende nur dokumentierte Felder und ignoriere unbekannte.
  • Nicht dokumentierte Filterattribute: Sie können funktionieren, gehören aber nicht zum dokumentierten Umfang.
  • Ergänzungen: Neue Endpunkte, neue optionale Felder und neue Fehlercodes können ohne Ankündigung hinzukommen. Behandle unbekannte Fehlercodes wie ihren HTTP-Status.
  • Texte: Der Inhalt von detail und die Reihenfolge von Feldern sind nicht festgelegt.
  • Limits: Die Limits sind technische Schutzgrenzen.

Siehe auch den Changelog.

Auf dieser Seite