API-Versionierung

docs101 verwendet URI-Pfad-Versionierung. Die API-Version ist Teil der URL:

https://docs101.com/api/v1/invoices
https://docs101.com/api/v1/customers

Aktuelle Version

Die aktuelle und einzige Version ist v1. Alle Endpunkte werden unter /api/v1/ bereitgestellt.

Nicht-brechende Änderungen

Folgende Änderungen erfolgen innerhalb von v1 und lösen keinen Versionswechsel aus:

• Neue optionale Felder in Antworten
• Neue Endpunkte
• Bugfixes und Performance-Verbesserungen
• Neue optionale Query-Parameter

Diese Ergänzungen sind abwärtskompatibel — bestehende Integrationen funktionieren ohne Anpassung weiter.

tipp

Gestalten Sie Ihre Integration so, dass unbekannte Felder in API-Antworten ignoriert werden. So stellen Sie sicher, dass neue optionale Felder Ihren Code nicht beeinträchtigen.

Brechende Änderungen

Eine neue API-Version (z. B. /api/v2/) wird eingeführt, wenn Änderungen bestehende Integrationen brechen würden:

• Entfernung oder Umbenennung bestehender Felder
• Änderung des Datentyps oder der Struktur einer Antwort
• Umbenennung oder Entfernung von Endpunkten
• Änderung erforderlicher Parameter

Migration & Deprecation

Wenn eine neue Version eingeführt wird:

• Ein Migrationsleitfaden dokumentiert alle brechenden Änderungen und beschreibt, wie Sie Ihre Integration aktualisieren
• Die vorherige Version bleibt für einen Übergangszeitraum verfügbar, damit Sie ausreichend Zeit für die Migration haben
• Deprecation-Zeitpläne werden im Voraus angekündigt

info

Es ist derzeit kein v2 geplant. Die v1-API ist stabil und wird aktiv gepflegt.