Versionamento e descontinuação da API

Saiba como o Inblog oferece suporte à API v1, anuncia futuras descontinuações e planeja o fim do suporte.

O Inblog versiona sua API REST no caminho da URL para que as automações possam usar um contrato previsível.

Suporte atual

v1 é a versão da API REST com suporte atual. Use endpoints em /api/v1/... e o documento OpenAPI para criar integrações.

Mantemos a compatibilidade retroativa dentro da v1 para as operações com suporte. Novos campos de resposta e outras melhorias não incompatíveis podem ser adicionados sem criar uma nova versão de URL. Não há uma data de descontinuação ou fim do suporte anunciada para a v1.

A API não envia atualmente os cabeçalhos de resposta Deprecation ou Sunset para a v1 apenas porque esta política existe. A ausência desses cabeçalhos significa que nenhum sinal de retirada foi anunciado.

Sinais futuros do ciclo de vida

Se a retirada de uma versão com suporte for planejada, o Inblog poderá usar estes cabeçalhos de resposta:

  • Deprecation indica que a versão foi descontinuada e pode incluir a data em que a descontinuação entra em vigor.
  • Sunset indica a data planejada depois da qual a versão deixará de ter suporte.

Esses sinais são diferentes: a descontinuação anuncia uma mudança no ciclo de vida, enquanto Sunset identifica o fim planejado do suporte. Quando estiverem presentes, registre os dois cabeçalhos e consulte a documentação ou o guia de migração vinculado.

Prazo de aviso

Nossa política normal é fornecer um aviso mínimo de 180 dias antes de remover a v1 ou fazer uma alteração incompatível em uma versão da API com suporte. Esse é um mínimo conservador, não uma promessa de que toda mudança seguirá exatamente esse cronograma.

Uma vulnerabilidade de segurança, uma exigência legal ou uma situação de emergência pode exigir um aviso mais curto ou uma mudança imediata. Nessas condições, comunicaremos o impacto e as medidas disponíveis assim que for possível.

Recomendações para clientes

  • Fixe as requisições em /api/v1 em vez de inferir a versão pelos cabeçalhos de resposta.
  • Trate campos adicionados como compatíveis e ignore os campos que o seu cliente não utiliza.
  • Monitore os cabeçalhos Deprecation e Sunset, as notas de versão e esta política ao planejar migrações.
  • Use o documento OpenAPI como fonte legível por máquina do contrato atual.

Última atualização em 2026-08-25