OpenAPI y Postman

La especificación OpenAPI

Esta documentación se genera a partir de una especificación OpenAPI 3.0, que es la fuente de verdad de las rutas, los campos y los errores:

Formato	Dirección
JSON	https://sudrel.com.br/docs/openapi.json
YAML	https://sudrel.com.br/docs/openapi.yaml
JSON en español	https://sudrel.com.br/docs/es/openapi.json
JSON en inglés	https://sudrel.com.br/docs/en/openapi.json

En las versiones en español e inglés solo cambian las explicaciones: las rutas, los campos y los códigos son los mismos.

Usa la especificación para generar un cliente en tu lenguaje (por ejemplo con OpenAPI Generator), para importarla en una herramienta de pruebas o para dar contexto a un asistente de IA.

Postman e Insomnia

1. En Postman, Import y pega https://sudrel.com.br/docs/openapi.json. En Insomnia, Import con la misma dirección.
2. La colección viene con todas las rutas y con la dirección base https://api.sudrel.com.br/api en una variable de la colección. Para agrupar las rutas por las secciones de esta documentación, elige organizar por tags en la importación.
3. En la autenticación de la colección, elige Bearer Token y pega tu clave. Empieza con una clave de prueba (sdr_test_): con ella, la emisión va al entorno de pruebas del Sistema Nacional, sin valor fiscal.
4. Guarda la clave en una variable de entorno de la herramienta, nunca en la colección que compartes.

Probar aquí mismo

En la referencia de la API, cada ruta tiene la prueba en la propia página, en la columna derecha: llena la clave en Auth una vez y vale para todas las rutas, guardada en tu navegador. La prueba llama a la API de verdad: con una clave de producción, una emisión vale como nota fiscal. Para probar la emisión, usa la clave de prueba.