ConverterHQDevelopers
API v1

Omgevingen en versionering

Promoveer veilig van sandbox naar productie en begrijp het v1-compatibiliteitscontract.

Test en live zijn geïsoleerd. Integreer eerst in sandbox, oefen foutpaden en webhooks en promoveer configuratie en secrets bewust.

Sandbox en productie

Configureer base URL en key expliciet per omgeving. Testcredentials zien geen live resources en omgekeerd.

API v1-contract

Publieke OpenAPI en gedocumenteerde schemas vormen het contract. CI blokkeert incompatibele wijzigingen die deprecation of een nieuwe major vereisen.

Compatibele toevoegingen

Nieuwe optionele velden, endpoints en capabilities kunnen verschijnen. Clients moeten onbekende velden negeren en fragiele exhaustieve enum-switches vermijden. Dezelfde regel geldt voor paarspecifieke conversieopties: ConverterHQ kan nieuwe optionele opties toevoegen, maar een bestaande v1-optie wordt niet verwijderd, verplicht gemaakt, van type of standaardsemantiek gewijzigd, van enumwaarden ontdaan of beperkt tot een smaller toegestaan bereik.

Deprecations

Een deprecation verschijnt in changelog met alternatief en migratievenster. Vertrouw niet op ongedocumenteerd gedrag of interne endpoints.