Sudrel API
Panel Crear clave de API

Documentación › Ayuda

Guías

Registro de cambios

Qué cambió en la API y en la documentación, por fecha.

API v1. Desde el 02/10/2026 el contrato de emisión está congelado: solo entran cambios que agregan (campo, ruta, evento, elemento de preparación, código de error). Nada de lo que existe se renombra, se elimina ni cambia de estado HTTP. Una regla que necesita cambiar de sentido recibe un id nuevo.

03/10/2026

Documentación

  • Nueva organización por tarea: "¿Qué quieres hacer?", reglas de integración, idempotencia, errores y estados HTTP, estados de la NFS-e, preparación, paginación, recetas, problemas comunes, glosario.
  • Respuestas de error documentadas ruta por ruta, con los dos formatos (problem+json y NestJS), incluidos 401 y 429.
  • Documentación también en español (/docs/es) e inglés (/docs/en).
  • Especificación OpenAPI publicada también en YAML (/docs/openapi.yaml) e índice para asistentes de IA en /docs/llms.txt.

02/10/2026

Agregado

  • Lote por la API: POST /v1/lotes (JSON u hoja de cálculo, hasta 5.000 elementos), consulta, elementos, informe, emisión manual y reprocesamiento. Webhook LOTE_EMISSAO_CONCLUIDO.
  • Registro de eventos GET /v1/eventos, con cursor y retención de 90 días.
  • Webhooks por la API (/v1/webhooks): firma X-Sudrel-Signature-V2 con hora, X-Sudrel-Event-Id y X-Sudrel-Delivery-Id, reintento durante 72 horas, cambio de secreto con 24 horas de convivencia, reenvío, encabezados propios y webhook de prueba separado del de producción.
  • Simulador de fallos (X-Sudrel-Simular) con la clave de prueba.
  • Registro de solicitudes de la API en el panel (Integrações › Log da API (Integraciones › Registro de la API)), por 30 días.
  • Preparación de la empresa (GET /v1/companies/{id}/prontidao), 412 empresa_nao_pronta y webhook EMPRESA_PRONTIDAO_ALTERADA.
  • Webhook NFSE_FALHA_TRANSMISSAO.
  • Parámetros oficiales del municipio (GET /v1/municipios/{ibge}/parametros).
  • IBS y CBS en la DPS del régimen regular, y GET /v1/servicos/{codigo}/nbs.
  • Sustitución de NFS-e (bloque substituicao en POST /v1/nfse) y datos de la obra (servico.obra).

Modificado

  • El cursor de GET /v1/eventos (proximo_cursor, seq y cursor_mais_antigo) pasó a ser un texto opaco. El cursor numérico anterior sigue aceptándose en apos.

01/10/2026

Agregado

  • Clave de prueba sdr_test_: emite de verdad en la producción restringida del Sistema Nacional, sin valor fiscal y sin cobrar.
  • Estado aguardando_confirmacao, POST /v1/nfse/{id}/confirmacao y webhook NFSE_AGUARDANDO_CONFIRMACAO.
  • Aviso processamento_prolongado y webhook NFSE_PROCESSAMENTO_PROLONGADO.

30/09/2026

Agregado

  • Emisión de NFS-e por la API: POST /v1/nfse, POST /v1/nfse/validacoes, GET /v1/nfse, GET /v1/nfse/{id}, XML, PDF y cancelación. Errores en problem+json, Idempotency-Key, Prefer: wait=N, ajustes y línea de tiempo en eventos. Webhooks NFSE_AUTORIZADA, NFSE_REJEITADA y NFSE_CANCELADA.