Imóveis na Bio · Informações oficiais

Ciclo de vida da API do Imóveis na Bio

Política pública de versionamento, compatibilidade, descontinuação e encerramento da API para integrações e agentes.

Ler em Markdown

Versão estável atual

A versão estável atual é v1 e usa o prefixo /api/v1. Mudanças compatíveis, como novos campos opcionais e novas operações, podem ser adicionadas dentro da mesma versão. Clientes devem ignorar campos desconhecidos e usar apenas as operações publicadas no OpenAPI.

Mudanças incompatíveis exigem uma nova versão principal, como /api/v2. As rotas sem versão existem para compatibilidade do aplicativo atual e não são o contrato recomendado para novas integrações.

Aviso de descontinuação

Nenhuma versão está em descontinuação hoje. Quando uma operação ou versão estável entrar em descontinuação, as respostas afetadas informarão o header Deprecation com uma data válida conforme RFC 9745 e um Link com rel=deprecation apontando para a orientação de migração.

O link da política pode aparecer antes do header Deprecation. Isso torna a política descobrível sem afirmar que o recurso atual já está descontinuado.

Prazo e encerramento

Uma versão principal estável terá no mínimo 180 dias entre o aviso público de descontinuação e o encerramento planejado. Quando houver data de encerramento, as respostas afetadas também informarão Sunset conforme RFC 8594. A data de Sunset nunca será anterior à data de Deprecation.

O prazo pode ser reduzido apenas quando uma mudança imediata for necessária para conter um risco ativo de segurança ou cumprir uma obrigação legal. Nesses casos, a documentação explicará o impacto e a alternativa disponível.