API: testar no Postman ou no Apidog

Para conhecer a API antes de programar, carregue todas as rotas num programa de teste de API. O Postman e o Apidog são gratuitos e abrem o mesmo arquivo.

Antes, siga o guia de integração para contratar o módulo API e criar o usuário da integração.

Cuidado

As rotas de cadastro, alteração, exclusão e emissão gravam de verdade. Teste primeiro numa empresa de teste.

REST

1. Baixe a coleção com todas as rotas.
2. No Postman, clique em Import e escolha o arquivo. No Apidog, use Importar dados e escolha o formato Postman.
3. Abra as variáveis da coleção e preencha usuario e senha com os dados do usuário da integração. No Postman, use a coluna Current value: ela fica só no seu computador e não vai junto quando a coleção é compartilhada.
4. Se você acessa o sistema por outro endereço, troque o baseUrl pelo endereço que você usa.
5. Escolha uma rota, por exemplo Notas fiscais > NF-e > List, e envie.

O login é feito sozinho antes da primeira chamada: o token fica na variável token e a empresa em org. Para operar em outra empresa do mesmo usuário, troque o org pelo identificador dela.

As rotas estão nas mesmas pastas da referência: por área e, dentro dela, por documento ou cadastro, como NF-e, NFC-e e Pedidos. A descrição de cada pasta traz o nome do serviço gRPC correspondente. As listagens vêm com o corpo vazio, que traz a primeira página. As demais trazem todos os campos com valores vazios, para você preencher o que precisa.

gRPC

Para chamar os mesmos métodos por gRPC, use os SDKs para Go e Python. A instalação e um exemplo estão no guia de integração e nos exemplos de código.