Sudrel API
Painel Criar chave de API

Documentação › Ajuda

Guias

Changelog

O que mudou na API e na documentação, por data.

API v1. Desde 02/10/2026 o contrato de emissão está congelado: só entram mudanças que acrescentam (campo, rota, evento, item de prontidão, código de erro). Nada que existe é renomeado, removido ou muda de status HTTP. Regra que precisa mudar de sentido ganha id novo.

03/10/2026

Documentação

  • Nova organização por tarefa: "O que você quer fazer?", regras de integração, idempotência, erros e status HTTP, estados da NFS-e, prontidão, paginação, receitas, problemas comuns, glossário.
  • Respostas de erro documentadas rota a rota, com os dois formatos (problem+json e NestJS), inclusive 401 e 429.
  • Documentação também em espanhol (/docs/es) e inglês (/docs/en).
  • Especificação OpenAPI publicada também em YAML (/docs/openapi.yaml) e índice para assistentes de IA em /docs/llms.txt.

02/10/2026

Acrescentado

  • Lote pela API: POST /v1/lotes (JSON ou planilha, até 5.000 itens), consulta, itens, relatório, emissão manual e reprocessamento. Webhook LOTE_EMISSAO_CONCLUIDO.
  • Log de eventos GET /v1/eventos, com cursor e retenção de 90 dias.
  • Webhooks pela API (/v1/webhooks): assinatura X-Sudrel-Signature-V2 com horário, X-Sudrel-Event-Id e X-Sudrel-Delivery-Id, retentativa por 72 horas, troca de segredo com 24 horas de convivência, reenvio, cabeçalhos próprios e webhook de teste separado do de produção.
  • Simulador de falhas (X-Sudrel-Simular) com a chave de teste.
  • Log de requisições da API no painel (Integrações › Log da API), por 30 dias.
  • Prontidão da empresa (GET /v1/companies/{id}/prontidao), 412 empresa_nao_pronta e webhook EMPRESA_PRONTIDAO_ALTERADA.
  • Webhook NFSE_FALHA_TRANSMISSAO.
  • Parâmetros oficiais do município (GET /v1/municipios/{ibge}/parametros).
  • IBS e CBS na DPS do regime regular, e GET /v1/servicos/{codigo}/nbs.
  • Substituição de NFS-e (bloco substituicao em POST /v1/nfse) e dados da obra (servico.obra).

Alterado

  • O cursor de GET /v1/eventos (proximo_cursor, seq e cursor_mais_antigo) passou a ser um texto opaco. O cursor numérico antigo continua aceito em apos.

01/10/2026

Acrescentado

  • Chave de teste sdr_test_: emite de verdade na produção restrita do Sistema Nacional, sem valor fiscal e sem cobrar.
  • Status aguardando_confirmacao, POST /v1/nfse/{id}/confirmacao e webhook NFSE_AGUARDANDO_CONFIRMACAO.
  • Aviso processamento_prolongado e webhook NFSE_PROCESSAMENTO_PROLONGADO.

30/09/2026

Acrescentado

  • Emissão de NFS-e pela API: POST /v1/nfse, POST /v1/nfse/validacoes, GET /v1/nfse, GET /v1/nfse/{id}, XML, PDF e cancelamento. Erros em problem+json, Idempotency-Key, Prefer: wait=N, ajustes e linha do tempo em eventos. Webhooks NFSE_AUTORIZADA, NFSE_REJEITADA e NFSE_CANCELADA.