singlefax
Sprache

Versionierung und Außerbetriebnahme der SingleFax-API

Agenten und Backends können sich auf diese Richtlinie verlassen. Die aktuelle REST-Schnittstelle ist /api/v1. Es ist keine Außerbetriebnahme geplant.

Versionierung

Die öffentliche REST-API ist im URL-Pfad versioniert: https://singlefax.com/api/v1/… und dieselben Pfade auf api.singlefax.com. OpenAPI ist unter /openapi.json verfügbar; info.version entspricht der Hauptversion des Pfads, derzeit 1.0.0.

Ergänzende, abwärtskompatible Änderungen wie neue optionale Felder, Endpunkte oder Fehlerwerte für data.code bleiben ohne Header in v1. Inkompatible Änderungen, entfernte Felder, geänderte Typen oder neue verpflichtende Authentifizierung erscheinen als /api/v2. Wir ändern die Struktur von v1-Anfragen oder -Antworten nicht stillschweigend.

Deprecation und Sunset

Wenn eine v1-Operation oder ein Feld entfällt, enthalten die zugehörigen Antworten RFC 8594 Deprecation mit dem Ankündigungsdatum und RFC 8594 Sunset mit dem Abschaltdatum. Zwischen Deprecation und Sunset liegen mindestens 90 Tage. OpenAPI markiert dieselben Operationen mit deprecated: true.

Aktuell enthält keine v1-Operation Deprecation oder Sunset. Für MCP Streamable HTTP unter /mcp gilt dieselbe Ankündigungsfrist bei Entfernung eines Tools.

Maschinenlesbare Quellen