Protocolo

Versões

A API tem versões datadas. Hoje existe: 2026-10-01.

• Mande a versão no cabeçalho Torqyn-Version. Sem ele, vale a mais recente. A resposta diz qual versão respondeu.
• Versão que não existe é invalid_version.
• Cada endpoint de webhook fica preso à versão com que foi criado: o corpo dele não muda de formato por baixo do seu sistema.

O que muda sem versão nova

Acrescentar não quebra: rota nova, campo novo numa resposta, parâmetro opcional novo, code de erro novo, tipo de evento novo. Escreva o seu sistema para ignorar campo que não conhece.

O que só sai em versão nova

Tirar ou renomear campo, mudar o tipo ou o sentido de um campo, tornar obrigatório o que era opcional, mudar o sentido de um code. A versão anterior continua funcionando e só é desligada com 12 meses de aviso, dado na página de mudanças.