Changelog

Registro de mudanças da API Hooked e desta documentação. As entradas mais recentes aparecem primeiro.

v1.1 — Maio 2026

Documentação

  • Novo módulo publicado: Mensagens (/api/mensagens) — templates de mensagens padronizadas usados como observações em pedidos, notas fiscais e romaneios.
  • Inclui callouts com limites confirmados empiricamente: descricao única server-side, máximo de 5000 caracteres, pageSize capado em 50 e parâmetro de paginação pageNumber (não page).
  • Adicionados paths /api/mensagens e /api/mensagens/{id} ao swagger.json, com os schemas MensagemViewModel e MensagemViewModelListViewModel.

Correção em Produtos & Serviços

  • Campo tipoItem foi corrigido na documentação — antes descrito como "P"/"S"/"MP", agora documentado corretamente como código de 2 dígitos da Tabela 03 do SPED Fiscal ("00" a "10", "99").
  • Adicionada nova seção "Tabela de valores de tipoItem" no fim de produtos-servicos.md com a lista completa dos 12 códigos válidos + descrições.
  • Schemas ProdutoServicoViewModel, ProdutoServico e FichaTecnicaViewModel no swagger.json agora declaram enum com os 12 valores SPED + description explicativa.

Correções de enums após probe empírico (análise de 45 módulos)

Execução de probe automático contra a API real (scripts/probe_enums.py) detectou 5 divergências entre a documentação e os valores reais retornados pelos endpoints. Todas foram corrigidas:

  • fichas-tecnicas — tipoItem: antes "PA"/"MP"/"PI", agora SPED Tabela 03 (mesma do Produtos & Serviços). Também documentados pela primeira vez classificacao ("N" = Normal/NCM) e tipoComissao ("P" = Percentual).
  • condicoes-pagamento — origem: antes só "M", agora documentados os 3 valores válidos M = Manual, P = à Prazo (parcelada), V = à Vista.
  • formas-pagamento — tipo: antes "ex: credito/debito" (incorreto), agora documentado o valor observado "D" com aviso de que o significado exato não está documentado. Campo origem corrigido para V/P (mesmo padrão de condicoes-pagamento).
  • naturezas-operacao — tipoPlanoConta: antes R/D (incorreto), agora documentado como string textual minúscula ("venda", "compra", "servico", "transferencia").
  • centros-custos-categorias — tipo: antes "1=Receita, 2=Despesa" (incorreto — há despesas com tipo=0), agora documentado os 4 valores observados (0, 1, 2, 3) com aviso de que a semântica não é "Receita/Despesa".

Os 6 schemas relacionados no swagger.json foram atualizados com enum (onde os valores são confirmados) e description explicando a correção. Relatório completo do probe disponível em relatorios/relatorio-enums.md.

v1.0 — Abril 2026

Documentação

  • Publicação inicial com 68 módulos de API + 3 guias (71 documentos no total)
  • Exemplos de código em cURL, JavaScript, Python, Go, PHP e n8n para cada endpoint
  • Guia de Primeiros Passos com fluxo completo de autenticação
  • Documentação do padrão de paginação
  • Coleção Postman disponível para download em /postman-collection.json — veja como importar e testar
  • Para testar os endpoints: teste aqui

Indicador de status da API

O header do site exibe em tempo real se a API está Online, Offline ou Degradado.

Como funciona:

  • Ao carregar qualquer página, o browser faz um GET para https://api.app.hooked.com.br/api/sobre
  • Se a resposta chegar com status HTTP < 500 → API Online (ponto verde)
  • Se a resposta chegar com status HTTP >= 500 → API Degradado (ponto amarelo)
  • Se a requisição falhar (sem rede, CORS, etc.) → API Offline (ponto vermelho)
  • Timeout máximo: 10 minutos — se não houver resposta nesse prazo, marca como Offline

API

  • Autenticação via Bearer Token (JWT)
  • Paginação padronizada com pageNumber / pageSize em todos os endpoints de listagem
  • Isolamento de tenant por licença em todos os endpoints
← PaginaçãoAcessos →