Primeros pasos
Versiones y obsolescencia
Entienda las versiones principales en la URL, las incorporaciones compatibles, los avisos de obsolescencia y los periodos de retirada.
Rutas de versión principal estables
Las integraciones de clientes usan una versión principal en la URL, actualmente /api/v1. El info.version de OpenAPI basado en fecha identifica el contrato exacto publicado dentro de esa versión principal.
Cambios compatibles
SendHQ puede agregar campos de solicitud opcionales, campos de respuesta, valores de enum cuando el esquema lo permite y nuevas operaciones dentro de v1. Los clientes deben ignorar los campos de respuesta desconocidos y no tratar un enum como cerrado definitivamente, salvo que el esquema lo indique.
Cambios incompatibles
Un cambio incompatible en la solicitud, la respuesta, la autenticación o el comportamiento requiere una nueva ruta principal como /api/v2, documentación de migración y una transición anunciada. La API v1 actual no está obsoleta.
Obsolescencia y retirada
Cuando una versión queda obsoleta, SendHQ documenta su reemplazo y la ruta de migración, y devuelve los encabezados Deprecation y Sunset cuando corresponde. Las versiones obsoletas siguen disponibles al menos 90 días después de la fecha de obsolescencia publicada, salvo que mantenerlas suponga un riesgo urgente de seguridad o legal.