ConverterHQDevelopers
API v1

Umgebungen und Versionierung

Sicher von Sandbox nach Produktion wechseln und den v1-Kompatibilitätsvertrag verstehen.

Test und Live sind isoliert. Integrieren Sie zuerst in der Sandbox, üben Sie Fehlerpfade und Webhooks und promoten Sie Konfiguration und Secrets bewusst.

Sandbox und Produktion

Basis-URL und Key pro Umgebung explizit konfigurieren. Test-Credentials dürfen keine Live-Ressourcen sehen und umgekehrt.

API-v1-Vertrag

Öffentliches OpenAPI und dokumentierte Schemas bilden den Vertrag. Inkompatible Änderungen werden in CI blockiert und brauchen Deprecation oder neue Major-Version.

Kompatible Erweiterungen

Neue optionale Felder, Endpunkte und capabilities können hinzukommen. Clients sollten unbekannte Felder ignorieren und keine fragilen exhaustiven Enum-Switches bauen. Dasselbe gilt für paarbezogene Konvertierungsoptionen: ConverterHQ kann neue optionale Optionen hinzufügen, aber eine bestehende v1-Option wird nicht entfernt, verpflichtend gemacht, im Typ oder in der Standardsemantik geändert, um Enum-Werte reduziert oder im zulässigen Bereich eingeschränkt.

Deprecations

Deprecations werden mit Alternative und Migrationsfenster im Changelog angekündigt. Verlassen Sie sich nicht auf undokumentiertes Verhalten oder interne Endpunkte.