OpenAPI e Postman

A especificação OpenAPI

Esta documentação é gerada de uma especificação OpenAPI 3.0, e ela é a fonte de verdade das rotas, dos campos e dos erros:

Formato	Endereço
JSON	https://sudrel.com.br/docs/openapi.json
YAML	https://sudrel.com.br/docs/openapi.yaml
JSON em espanhol	https://sudrel.com.br/docs/es/openapi.json
JSON em inglês	https://sudrel.com.br/docs/en/openapi.json

Nas versões em espanhol e inglês só as explicações mudam: rotas, campos e códigos são os mesmos.

Use a especificação para gerar um cliente na sua linguagem (por exemplo com o OpenAPI Generator), para importar numa ferramenta de testes ou para dar contexto a um assistente de IA.

Postman e Insomnia

1. No Postman, Import e cole https://sudrel.com.br/docs/openapi.json. No Insomnia, Import com o mesmo endereço.
2. A coleção vem com todas as rotas e com o endereço base https://api.sudrel.com.br/api numa variável da coleção. Para agrupar as rotas pelas seções desta documentação, escolha organizar por tags na importação.
3. Na autenticação da coleção, escolha Bearer Token e cole a sua chave. Comece com uma chave de teste (sdr_test_): com ela, a emissão vai ao ambiente de testes do Sistema Nacional, sem valor fiscal.
4. Guarde a chave numa variável de ambiente da ferramenta, nunca na coleção que você compartilha.

Testar aqui mesmo

Na referência da API, cada rota tem o teste na própria página, na coluna da direita: preencha a chave em Auth uma vez e ela vale para todas as rotas, guardada no seu navegador. O teste chama a API de verdade: com uma chave de produção, uma emissão vale como nota fiscal. Para testar emissão, use a chave de teste.