​
Testando com Postman

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 Variables
  3. Preencha o campo token com seu token de acesso
  4. 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:
VariavelDescricaoExemplo
base_urlURL base da API (ja preenchida)https://221b-api.sherlocker.com.br/api/v1
tokenSeu token de acessosk_live_...
cpfCPF para testes12345678901
cnpjCNPJ para testes12345678000199
telefoneTelefone com DDD11987654321
emailEmail para buscas reversas[email protected]
placaPlaca do veiculoABC1D23
ufSigla do estadoSP
jobIdID do job async (preenchido automaticamente)—
termoTermo de busca para documentosJoao Silva
Preencha cpf, cnpj e token uma vez e todas as requests da collection usarao esses valores automaticamente.

​
Estrutura da collection

A collection esta organizada nas mesmas categorias da API:
PastaEndpointsDescricao
Pessoas7Perfil, contatos, parentes, busca reversa por telefone
Perfis Digitais3Perfis em plataformas a partir de email
Empresas7Dados cadastrais, socios, funcionarios, empregos
Trabalhista1Dados trabalhistas por CNPJ
Imoveis6Imoveis urbanos por CPF/CNPJ, com filtro por UF e modo async
Rural8Imoveis rurais, CAFIR, fiscalizacao, transportes
Veiculos3Veiculos por CPF, CNPJ ou placa
Aeronaves2Aeronaves por CPF ou CNPJ
Patentes2Propriedade intelectual por CPF ou CNPJ
Processos5Processos judiciais com modo async
Dividas2Divida ativa por CPF ou CNPJ
Regularidade2Sancoes e restricoes por CPF ou CNPJ
Beneficios2Beneficios sociais e renuncias fiscais
Leads3Enriquecimento de contatos e geracao B2B
Bancos3Contas bancarias com modo async
Cadastros3Cadastros em estabelecimentos com modo async
Documentos1Busca em diarios oficiais
Encomendas1Encomendas por CPF
NF-e2Notas fiscais por chave ou em lote

​
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}}?token={{token}}. Se voce ja configurou as variaveis, os valores aparecerao ao passar o mouse.
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:
{
  "job_id": "abc123-def456",
  "status": "processing"
}
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 Leads e NF-e requerem body JSON. A collection ja vem com exemplos pre-preenchidos.

​
Enriquecer contatos

{
  "contatos": [
    { "cpf": "12345678901" }
  ],
  "campos": [
    "identidade",
    "renda",
    "contatos",
    "empresas"
  ]
}

​
Gerar leads B2B

{
  "filtros": {
    "cnae": "6201",
    "uf": "SP"
  },
  "limite": 10,
  "incluir_contatos_socios": true
}

​
NF-e em lote

{
  "chaves": [
    "12345678901234567890123456789012345678901234"
  ]
}

​
Dicas

  • Erros 401: verifique se o token esta preenchido corretamente nas variaveis
  • 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