Zum Inhalt

Versionierungsrichtlinie

xTool nutzt API-Versionen im URL-Pfad. Die aktuelle Version ist v2; nutzen Sie sie für neue Integrationen. v1 wird unterstützt und bleibt unterstützt.

API-Versionen

Version Pfadpräfix Status
v2 /api/v2/ Aktuell. Für neue Integrationen verwenden.
v1 /api/v1/ Unterstützt. Documents, invoice convert, PDF. Bleibt unterstützt. Siehe Migration für den Wechsel zu v2.

Siehe API-Referenz und Migration.

v2 verwenden

Neue Integrationen sollten v2-Endpoints nutzen. v1 wird unterstützt und bleibt unterstützt; neue Funktionen kommen in v2.

Stabilität und Breaking Changes

  • Alpha (falls künftig genutzt) — Kann für Kundentests und Feedback freigegeben werden. Nicht stabil; nicht produktionsreif; Breaking Changes sind möglich.
  • Beta (falls künftig genutzt) — Kann für Kundentests und Feedback freigegeben werden. Noch nicht stabil bzw. produktionsreif; Breaking Changes werden vorab angekündigt (z. B. in Release Notes).

Aktuell liegen alle v2-Endpoints unter /api/v2/ ohne Alpha-/Beta-Pfadsegmente.

Wenn wir einen Endpoint oder eine Version einstellen, kündigen wir das an und bieten einen Migrationspfad. Siehe Migration.