OpenAPI and Postman

The OpenAPI specification

This documentation is generated from an OpenAPI 3.0 specification, and it is the source of truth for routes, fields and errors:

Format	Address
JSON	https://sudrel.com.br/docs/openapi.json
YAML	https://sudrel.com.br/docs/openapi.yaml
JSON in Spanish	https://sudrel.com.br/docs/es/openapi.json
JSON in English	https://sudrel.com.br/docs/en/openapi.json

In the Spanish and English versions only the explanations change: routes, fields and codes are the same.

Use the specification to generate a client in your language (for example with OpenAPI Generator), to import into a testing tool or to give context to an AI assistant.

Postman and Insomnia

1. In Postman, Import and paste https://sudrel.com.br/docs/openapi.json. In Insomnia, Import with the same address.
2. The collection comes with all routes and with the base address https://api.sudrel.com.br/api in a collection variable. To group the routes by the sections of this documentation, choose to organize by tags on import.
3. In the collection's authentication, choose Bearer Token and paste your key. Start with a test key (sdr_test_): with it, issuance goes to the test environment of the Sistema Nacional NFS-e, with no fiscal value.
4. Keep the key in an environment variable of the tool, never in the collection you share.

Try it right here

In the API reference, every endpoint has in-page testing, in the right-hand column: fill in the key under Auth once and it applies to every endpoint, saved in your browser. The test calls the real API: with a production key, an issuance counts as a real invoice. To test issuance, use the test key.