Versões atuais
Versão nas URLs
O número da versão aparece no caminho do endpoint:Mudanças breaking vs. non-breaking
Mudanças breaking (exigem atualizações de código)
Essas mudanças só ocorrem em atualizações de versão maiores:- Remoção de um endpoint
- Remoção de um field da resposta
- Remoção de um parâmetro de consulta
- Adição de um novo parâmetro obrigatório
- Alteração do tipo de dados de um field
- Renomeação de um field ou recurso
- Alteração de códigos de resposta ou tipos de erro
- Modificação de escopos de autorização
Mudanças non-breaking (aditivas)
Estas podem ocorrer a qualquer momento sem alteração de versão:- Adição de um novo endpoint
- Adição de um novo parâmetro opcional
- Adição de um novo field de resposta
- Adição de novos escopos OAuth
- Alteração do texto da mensagem de erro
- Definição de fields como null por motivos de privacidade/segurança
Cronograma de lançamentos
Política de depreciação
Quando lançamos uma nova versão maior:- Depreciação: A versão anterior é marcada como depreciada
- Período de suporte: A versão depreciada continua funcionando por um período definido
- Retirada: A versão depreciada é removida
Definições
Mantenha-se informado
Seja notificado sobre mudanças:
Changelog
Todas as mudanças e atualizações da plataforma.
Anúncios do Fórum
Avisos de breaking changes.
@XDevelopers
Notícias e atualizações da plataforma.
Newsletter
Resumo mensal.
Recursos de migração
Quando uma nova versão é lançada, fornecemos:- Guias de migração: Instruções passo a passo de upgrade
- Mapeamento de endpoints: Equivalentes v1 para v2
- Mudanças de formato de dados: Diferenças no modelo de objetos
Visão geral da migração
Orientação atual de migração.
Mapa de endpoints
Mapeamento de endpoints v1 para v2.
Boas práticas
Use v2
Comece novos projetos na versão mais recente.
Monitore anúncios
Assine o changelog e as atualizações do fórum.
Teste as mudanças
Teste em desenvolvimento antes de atualizações em produção.
Planeje migrações
Não espere até a depreciação para fazer o upgrade.