Erste Schritte

Versionierung und Abkündigung

Größere URL-Versionen, kompatible Ergänzungen, Abkündigungshinweise und Sunset-Fristen verstehen.

Stabile Major-Pfade

Kundenintegrationen verwenden eine Major-Version in der URL, derzeit /api/v1. Die datumsbasierte OpenAPI-info.version kennzeichnet den exakt veröffentlichten Vertrag innerhalb dieser Major-Version.

Kompatible Änderungen

SendHQ kann innerhalb von v1 optionale Anfragefelder, Antwortfelder, Enum-Werte (sofern das Schema sie zulässt) und neue Operationen hinzufügen. Clients sollten unbekannte Antwortfelder ignorieren und ein Enum nicht als dauerhaft abgeschlossen betrachten, sofern das Schema nichts anderes sagt.

Breaking Changes

Eine inkompatible Änderung bei Anfrage, Antwort, Authentifizierung oder Verhalten erfordert einen neuen Major-Pfad wie /api/v2, eine Migrationsdokumentation und einen angekündigten Übergang. Die aktuelle v1-API ist nicht abgekündigt.

Abkündigung und Sunset

Wird eine Version abgekündigt, dokumentiert SendHQ die Ersatzversion und den Migrationspfad und liefert gegebenenfalls die Header Deprecation und Sunset. Abgekündigte Versionen bleiben nach dem veröffentlichten Abkündigungsdatum mindestens 90 Tage verfügbar, sofern der Weiterbetrieb kein dringendes Sicherheits- oder Rechtsrisiko schafft.