Skip to main content

​
Testando a API

O Postman e uma das formas mais rapidas de explorar a API do Sherlocker sem escrever codigo. Disponibilizamos uma collection pronta com todos os endpoints, variaveis pre-configuradas e exemplos de body para requests POST.

​
Importando a collection

1

Baixar a collection

Faca download do arquivo sherlocker-postman-collection.json.
2

Abrir o Postman

Abra o Postman (desktop ou web).
3

Importar

Clique em Import (canto superior esquerdo) e arraste o arquivo JSON ou clique em Upload Files para seleciona-lo.Voce vera a collection Sherlocker API com todas as pastas de endpoints.
4

Configurar o token

  1. Clique na collection Sherlocker API na barra lateral.
  2. Va na aba Authorization.
  3. Selecione o tipo Bearer Token.
  4. No campo Token, insira {{token}}.
  5. Va na aba Variables e preencha o campo token com seu token de acesso.
  6. Clique em Save (Ctrl+S).
Nunca compartilhe sua collection com o token preenchido. Use a coluna Current value (que nao e exportada) em vez de Initial value.

​
Variaveis da collection

A collection usa variaveis para facilitar os testes. Edite na aba Variables da collection:
Preencha cpf, cnpj e token uma vez e todas as requests da collection usarao esses valores automaticamente.

​
Testando sua primeira request

1

Abrir uma request

Expanda a pasta Pessoas e clique em Perfil completo por CPF.
2

Verificar variaveis

Na URL voce vera {{base_url}}/pessoas/cpf/{{cpf}}. O token e enviado automaticamente via Bearer no header Authorization.
3

Enviar

Clique em Send. Voce recebera o perfil completo com nome, enderecos, telefones, emails e parentes.
4

Analisar resposta

A resposta vem em JSON. Use a aba Pretty para visualizar formatado ou Raw para ver o JSON bruto.

​
Testando endpoints async

Alguns modulos (processos, perfis, bancos, cadastros, imoveis) possuem modo async para consultas demoradas:
1

Iniciar o job

Abra a request Processos por CPF (async) na pasta Processos e clique Send.A resposta contera um jobId:
2

Copiar o jobId

Copie o valor de job_id da resposta.
3

Atualizar variavel

Va na aba Variables da collection e cole o valor no campo jobId. Salve.
4

Consultar status

Abra Status do job de processos e clique Send. Repita ate o status ser completed.
Para automatizar o polling, use o Collection Runner do Postman com um teste que verifica se status === "completed" e faz retry.

​
Testando endpoints POST

Os endpoints de NF-e requerem body JSON. A collection ja vem com exemplos pre-preenchidos.

​
NF-e em lote

​
Dicas

  • Erros 401: verifique se o token esta preenchido corretamente nas variaveis e se a aba Authorization da collection esta configurada como Bearer Token com valor {{token}}.
  • Erros 402: saldo de tokens insuficiente para o modulo consultado.
  • Erros 404: o CPF/CNPJ nao foi encontrado ou o endpoint esta incorreto.
  • Timeout: para modulos demorados, use o modo async (POST) em vez do sincrono (GET).
  • Console: use o Postman Console (View → Show Postman Console) para debugar headers e payloads enviados.