Entrei API

Documentação

Integração direta com os módulos de consulta, consulta de saldo e cobrança variável por módulo concluído.

API v1

Começando

Envie sua chave no header Authorization. A chave completa aparece apenas no momento em que é criada no painel.

Authorization: Bearer fc_live_SUA_API_KEY
Content-Type: application/json

Também é aceito X-API-Key: fc_live_SUA_API_KEY.

Consultar saldo

GET/api/v1/creditos

curl https://entrei.shop/api/v1/creditos \
  -H "Authorization: Bearer SUA_API_KEY"

O alias /api/v1/saldo também está disponível. A resposta mostra somente o saldo da API key autenticada.

{
  "success": true,
  "api": {"name": "Minha integração"},
  "billing": {
    "credits": 44
  }
}

Listar módulos

GET/api/v1/modulos

curl https://entrei.shop/api/v1/modulos \
  -H "Authorization: Bearer SUA_API_KEY"

Fazer consulta

POST/api/v1/consulta/{modulo}

curl -X POST https://entrei.shop/api/v1/consulta/cpf \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cpf":"00000000000"}'

Módulos e campos

MóduloCréditosJSONObservação
veiculo5{"placa":"..."}Veículo
radar5{"placa":"..."}Radar Cortex
osint1{"tipo":"cpf","valor":"..."}Investigar OSINT; tipo padrão: cpf
telefone201{"valor":"..."}Telefone 2.0
processos1{"tipo":"cpf","valor":"..."}CPF, CNPJ, OAB ou processo
cpf1{"cpf":"..."}CPF
cpf21{"cpf":"..."}CPF Online
synapse5{"cpf":"..."}CPF Synapse
cnpj1{"cnpj":"..."}CNPJ
cnh10{"cpf":"..."}CNH
fotocnh5{"cpf":"..."}Foto CNH
nome1{"nome":"..."}Nome; uf, sexo, ano e exato são opcionais
pix1{"masked_cpf":"...","nome_prefixo":"..."}Os dois campos são necessários
mandados5{"cpf":"..."}Mandados

Resposta

{
  "success": true,
  "tipo": "radar",
  "http_code": 200,
  "data": { ... },
  "billing": {
    "charged": 5,
    "module_cost": 5,
    "credits": 44
  }
}

Saldo: use GET /api/v1/creditos para consultar os créditos disponíveis sem consumir nenhum crédito. Cada consulta concluída desconta o custo exibido na tabela do saldo da própria API key. Se o provedor falhar, a reserva integral é devolvida e charged fica em 0.

Erros comuns

400Parâmetros ou módulo inválido.
401API key ausente, inválida, revogada ou conta suspensa.
402Saldo de créditos insuficiente.
502Serviço de consulta temporariamente indisponível.