Prefixo de versão
Todos os endpoints da Synapse API incluem um prefixo de versão no caminho. A versão estável atual é v1.Garantia de estabilidade
Dentro de uma versão, a API não vai introduzir mudanças incompatíveis. São consideradas incompatíveis:- Remover um endpoint ou método HTTP
- Remover ou renomear um campo de resposta
- Mudar o tipo de um campo existente
- Adicionar um novo campo obrigatório na requisição
- Mudar códigos de erro pra cenários existentes
- Adicionar novos campos opcionais na requisição
- Adicionar novos campos na resposta
- Adicionar novos endpoints
- Adicionar novos códigos de erro pra novos cenários
Política de deprecação
Quando uma nova versão é publicada (ex.v2):
- A versão anterior entra em um período de deprecação de pelo menos 6 meses
- Versões deprecadas retornam um header
Sunsetcom a data planejada de remoção - Após o período de deprecação, a versão antiga pode ser removida
Versões atuais
| Versão | Status | URL base |
|---|---|---|
v1 | Estável | https://synapse.telepatia.ai/v1 |