ConverterHQDevelopers
API v1

Entornos y versionado

Promueve con seguridad del sandbox a producción y entiende el contrato v1.

Test y live están aislados. Integra primero en sandbox, ejercita errores y webhooks y promueve configuración y secretos deliberadamente.

Sandbox y producción

Configura URL base y key explícitamente por entorno. Una credencial test no debe ver recursos live y viceversa.

Contrato API v1

OpenAPI público y esquemas documentados forman el contrato. CI bloquea cambios incompatibles, que requieren deprecación o nueva versión mayor.

Adiciones compatibles

Pueden añadirse campos opcionales, endpoints y capabilities. Los clientes deben ignorar campos desconocidos y evitar switches exhaustivos frágiles en enums extensibles. La misma regla se aplica a las opciones de conversión por par: ConverterHQ puede añadir opciones opcionales, pero una opción v1 existente no se eliminará, no pasará a ser obligatoria, no cambiará de tipo ni de semántica predeterminada, no perderá valores enum ni verá reducido su rango aceptado.

Deprecaciones

Toda deprecación se anuncia en changelog con alternativa y ventana de migración. No dependas de comportamiento no documentado ni endpoints internos.