Clickfin

Referência da API
Portal oficial

Versionamento

Compatibilidade e mudanças

A API não usa prefixo de versão (/v1): as rotas desta referência são estáveis e evoluem de forma compatível. A versão atual do contrato é 2.10.4, em info.version do openapi.json, e acompanha as entregas da API.

Pode mudar a qualquer momento

  • Campos novos em respostas.
  • Campos opcionais novos em requisições.
  • Operações, escopos e categorias de erro novos.
  • Textos de message (trate erros por category e status HTTP).
  • Ordem de campos no JSON.

Só com aviso de 90 dias

  • Remover ou renomear um campo, uma operação ou um escopo.
  • Tornar obrigatório um campo opcional.
  • Mudar o tipo ou o significado de um campo.
  • Mudar o status HTTP ou a categoria de um erro existente.

Como se preparar

  • Ignore campos desconhecidos nas respostas em vez de recusar o JSON.
  • Trate qualquer category nova de um mesmo status HTTP como o caso genérico daquele status.
  • Mudanças que exigem aviso são anunciadas com pelo menos 90 dias de antecedência e registradas no changelog da API antes de entrarem em vigor.