API Admin › Guias

Versões

A versão vem no caminho, como uma data: /admin/2026-10/.... Toda resposta diz qual versão respondeu, no cabeçalho Denaryx-Api-Version.

  • O que não muda a versão: rota nova, campo novo numa resposta, filtro novo, valor novo num campo de lista aberta (como um código de erro). Escreva a integração para ignorar o que ela não conhece.
  • O que pede versão nova: tirar ou renomear um campo, mudar o tipo ou o sentido de um campo, tornar obrigatório o que era opcional, mudar o comportamento de uma rota.
  • Prazo: cada versão vale pelo menos 12 meses depois da publicação da seguinte. A versão que vai sair recebe os cabeçalhos Deprecation e Sunset com antecedência, e quem cuida das integrações é avisado.

Uma versão inexistente no caminho responde 404 (route_not_found).

Versões publicadas

VersãoSituação
2026-10Atual

Cada integração guarda a versão em que foi criada: é nela que o corpo dos webhooks dela é montado (api_version no corpo e o cabeçalho Denaryx-Api-Version).

A especificação OpenAPI de cada versão é servida pela própria API, sem token, em GET /admin/<versão>/openapi.json (a da 2026-10).