Pular para o conteúdo
Acessar sistema

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.

REST

Seção intitulada “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

Seção intitulada “gRPC”

O Postman e o Apidog não guardam chamadas gRPC num arquivo de coleção. Eles leem a descrição dos serviços de arquivos .proto, que estão no pacote dos SDKs.

  1. Baixe o pacote dos SDKs e descompacte. A pasta protos tem todos os serviços.
  2. No Postman, crie uma requisição gRPC dentro da coleção. Em Service definition, importe o arquivo protos/api.proto e adicione a pasta protos em Import paths.
  3. No endereço, informe o do sistema sem o https:// (por exemplo app.suaempresa.com.br) e ligue o TLS.
  4. Em Metadata, adicione token com o valor {{token}} e org com o valor {{org}}.
  5. Escolha o método, gere a mensagem de exemplo e clique em Invoke.

Com o token vazio, rode antes a rota Acesso > Login da coleção: é ela que entra e preenche o token e o org.

No Apidog, importe o arquivo do serviço que vai testar, como protos/apps/dfe/nfe/nfe.proto, e informe a pasta protos como pasta de dependências.

Pelo terminal

Seção intitulada “Pelo terminal”

O arquivo api.protoset, no mesmo pacote, descreve todos os serviços para o grpcurl e o grpcui. O grpcui abre no navegador uma tela com todos os métodos para preencher e enviar:

Terminal window
grpcui -protoset api.protoset -rpc-header "token: $TOKEN" -rpc-header "org: $ORG" app.suaempresa.com.br:443

O token e o identificador da empresa são os que o login devolve, como mostra o guia de integração.