ConverterHQDevelopers
API v1

Środowiska i wersjonowanie

Bezpiecznie przechodź z sandbox do produkcji i rozum kontrakt kompatybilności v1.

Test i live są izolowane. Integruj najpierw w sandbox, ćwicz failure paths i webhooks, a konfigurację i secrets promuj świadomie.

Sandbox i produkcja

Konfiguruj base URL i key jawnie dla środowiska. Test credential nie widzi live resources i odwrotnie.

Kontrakt API v1

Public OpenAPI i udokumentowane schemas są kontraktem. CI blokuje incompatible zmiany wymagające deprecacji lub nowego major.

Kompatybilne dodatki

Mogą pojawiać się nowe opcjonalne fields, endpoints i capabilities. Klient powinien ignorować nieznane pola i unikać kruchych exhaustive enum switches. Ta sama zasada dotyczy opcji konwersji zależnych od pary: ConverterHQ może dodawać nowe opcjonalne ustawienia, ale istniejąca opcja v1 nie zostanie usunięta, ustawiona jako wymagana, zmieniona pod względem typu lub semantyki wartości domyślnej, pozbawiona wartości enum ani ograniczona do węższego dozwolonego zakresu.

Deprecacje

Deprecacja pojawia się w changelog z alternatywą i oknem migracji. Nie polegaj na nieudokumentowanym zachowaniu ani internal endpoints.