ConverterHQDevelopers
API v1

Ambientes e versionamento

Promova com segurança do sandbox para produção e entenda o contrato de compatibilidade v1.

Test e live são isolados. Integre no sandbox, teste falhas e webhooks e promova configuração e segredos deliberadamente.

Sandbox e produção

Configure URL base e chave explicitamente por ambiente. Uma credencial test não acessa recursos live e vice-versa.

Contrato API v1

OpenAPI público e schemas documentados formam o contrato. CI bloqueia mudanças incompatíveis, que exigem depreciação ou nova major.

Adições compatíveis

Novos campos opcionais, endpoints e capabilities podem surgir. Clientes devem ignorar campos desconhecidos e evitar switches exaustivos frágeis em enums extensíveis. A mesma regra vale para opções de conversão específicas de cada par: a ConverterHQ pode adicionar novas opções opcionais, mas uma opção v1 existente não será removida, tornada obrigatória, alterada no tipo ou na semântica padrão, terá valores enum removidos ou o intervalo aceito reduzido.

Depreciações

Uma depreciação aparece no changelog com alternativa e janela de migração. Não dependa de comportamento não documentado ou endpoints internos.