simpla.fydocs
Hub API

Changelog

Registro de mudanças notáveis da Hub API — versões, correções e novidades publicadas em https://hub.simplafy.com.br/api/v1.

Changelog

Esta página registra mudanças notáveis da Hub API publicadas em https://hub.simplafy.com.br/api/v1. O formato segue Keep a Changelog e o projeto adota Semantic Versioning.

Como leio essa página

Cada entrada agrupa mudanças por categoria, no mesmo padrão usado no CHANGELOG.md do repositório:

  • Added — novos endpoints, recursos ou parâmetros.
  • Changed — alterações em comportamento, payload ou contratos já existentes.
  • Deprecated — funcionalidades marcadas para remoção; ainda disponíveis, mas evite novos usos.
  • Removed — funcionalidades retiradas. Chamadas antigas passam a falhar.
  • Fixed — correções de bugs, sem mudança de contrato.
  • Security — correções de segurança.

Mudanças que quebram contrato (breaking changes) sempre vêm sinalizadas em Changed ou Removed, com o caminho do endpoint afetado e a versão a partir da qual o novo comportamento vale.

Endpoints, payloads e códigos de erro detalhados ficam na referência da API. Esta página é o índice cronológico do que muda entre releases.

Versão atual (em desenvolvimento)

A Hub API está na versão 0.1.0 (ver apps/api/package.json). O contrato ainda está sendo estabilizado e pode mudar antes do primeiro release com SemVer estável.

Enquanto a versão estiver em 0.x, mudanças de contrato podem ocorrer entre deploys sem bump de versão major. Recomendamos fixar a versão da spec OpenAPI consumida em integrações e revisar este changelog antes de subir cliente novo para produção.

Mudanças em andamento no repositório (seção [Unreleased] do CHANGELOG.md) são focadas no app web (apps/web) e não alteram o contrato HTTP da API. Quando uma release oficial da API for cortada, ela aparece como nova seção H2 abaixo.

Para acompanhar o que está em revisão antes de virar release:

2026-05 — base launch (placeholder)

Marco inicial da documentação pública da Hub API em docs.simplafy.com.br/hub-api. As entradas detalhadas (endpoints disponíveis, escopos de permissão, contratos de webhook) serão preenchidas no primeiro release oficial.

Escopo coberto desde o início:

  • Gateway REST em https://hub.simplafy.com.br/api/v1, servido por apps/api (Next.js 15 Route Handlers).
  • Autenticação JWT HS256 com access token de curta duração e refresh com rotação.
  • Spec OpenAPI gerada via @asteasolutions/zod-to-openapi e Swagger UI em hub.simplafy.com.br/docs.

On this page