Comece aqui
Versionamento e descontinuação
Entenda as versões principais na URL, adições compatíveis, avisos de descontinuação e janelas de desativação.
Caminhos principais estáveis
As integrações de clientes usam uma versão principal na URL, atualmente /api/v1. O info.version do OpenAPI, baseado em data, identifica o contrato publicado exato dentro dessa versão principal.
Mudanças compatíveis
O SendHQ pode adicionar campos opcionais de requisição, campos de resposta, valores de enum onde o schema permitir e novas operações dentro de v1. Os clientes devem ignorar campos de resposta desconhecidos e evitar tratar um enum como permanentemente fechado, a menos que o schema diga isso.
Mudanças incompatíveis
Uma mudança incompatível em requisição, resposta, autenticação ou comportamento exige um novo caminho principal, como /api/v2, documentação de migração e uma transição anunciada. A API v1 atual não está descontinuada.
Descontinuação e desativação
Quando uma versão é descontinuada, o SendHQ documenta a substituição e o caminho de migração e retorna os cabeçalhos Deprecation e Sunset quando aplicável. As versões descontinuadas permanecem disponíveis por pelo menos 90 dias após a data de descontinuação publicada, a menos que a continuidade da operação crie um risco urgente de segurança ou jurídico.