API IMBRANET · v1

Status do serviço. Verifica se a API está no ar e se o banco responde. Ideal para monitores de uptime. Não exige autenticação e não expõe nenhum dado.

Exemplo

Copiarcurl -s "https://sysimb.imbranet.com.br/api/v1/healthcheck.php"

Copiarconst r = await fetch('https://sysimb.imbranet.com.br/api/v1/healthcheck.php', {
  method: 'GET',
});
const data = await r.json();
console.log(data);

Copiar<?php
$ch = curl_init('https://sysimb.imbranet.com.br/api/v1/healthcheck.php');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
]);
$resp = json_decode(curl_exec($ch), true);
print_r($resp);

Resposta

Copiar{
  "ok": true,
  "data": {
    "service": "sysimb-api",
    "version": "v1",
    "status": "online",
    "banco": "ok",
    "horario": "2026-06-25T05:28:44-03:00"
  }
}

Identidade (whoami). Valida a sua chave e devolve a identidade da aplicação (nome, escopos, IP de origem). Use para confirmar que a credencial está funcionando.

Exemplo

Copiarcurl -s "https://sysimb.imbranet.com.br/api/v1/ping.php" \
  -H "Authorization: Bearer SUA_CHAVE"

Copiarconst r = await fetch('https://sysimb.imbranet.com.br/api/v1/ping.php', {
  method: 'GET',
  headers: { 'Authorization': 'Bearer SUA_CHAVE' }
});
const data = await r.json();
console.log(data);

Copiar<?php
$ch = curl_init('https://sysimb.imbranet.com.br/api/v1/ping.php');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer SUA_CHAVE'],
]);
$resp = json_decode(curl_exec($ch), true);
print_r($resp);

Resposta

Copiar{
  "ok": true,
  "data": {
    "mensagem": "pong",
    "aplicacao": "Site institucional",
    "escopos": ["*"],
    "seu_ip": "200.1.2.3",
    "horario": "2026-06-25T05:29:01-03:00"
  }
}

Consultar CPF no SPC. Consulta a situação de um CPF no SPC Brasil (restrição, score, protestos, ações, cheques, pendências e valor de dívidas). Com consulta_nova=1 vai direto ao SPC; com 0 (ou ausente) reaproveita o histórico do SysIMB quando há consulta válida e só vai ao SPC se não houver. Aceita GET ou POST.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
cpf	string	Sim	CPF do consumidor (com ou sem máscara).
consulta_nova	inteiro	Não	1 = consulta nova direto no SPC; 0 ou ausente = usa o histórico do SysIMB antes (padrão 0).
detalhado	inteiro	Não	1 = inclui também a resposta bruta do SPC em "spc_raw".

Exemplo

Copiarcurl -s "https://sysimb.imbranet.com.br/api/v1/spc_consultar.php" \
  -H "Authorization: Bearer SUA_CHAVE"

Copiarconst r = await fetch('https://sysimb.imbranet.com.br/api/v1/spc_consultar.php', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer SUA_CHAVE' }
});
const data = await r.json();
console.log(data);

Copiar<?php
$ch = curl_init('https://sysimb.imbranet.com.br/api/v1/spc_consultar.php');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer SUA_CHAVE'],
]);
$resp = json_decode(curl_exec($ch), true);
print_r($resp);

Resposta

Copiar{
  "ok": true,
  "data": {
    "cpf": "12345678900",
    "consulta_nova": false,
    "origem": "historico",
    "consultado_em": "2026-06-25 10:00:00",
    "protocolo": "2026062301234567",
    "nome": "FULANO DE TAL",
    "tem_restricao": false,
    "score": 712,
    "score_classe": "Verde",
    "resumo": {
      "registros_spc": 0,
      "protestos": 0,
      "acoes": 0,
      "cheques": 0,
      "pendencias_financeiras": 0,
      "consultas_recentes": 3,
      "valor_total_dividas": 0
    },
    "consulta_id": 1016
  }
}

Validar área de cobertura. Verifica se um ponto está dentro de alguma área de cobertura ativa. Informe o ponto por GPS (lat+lng), CEP ou endereço (prioridade: GPS > CEP > endereço). CEP e endereço são geocodificados automaticamente. Aceita GET ou POST.

Parâmetros

Nome	Tipo	Obrigatório	Descrição
lat	número	Não	Latitude (use junto com lng).
lng	número	Não	Longitude (use junto com lat).
cep	string	Não	CEP (com ou sem máscara). Usado se lat/lng não vierem.
endereco	string	Não	Endereço livre. Usado se lat/lng e cep não vierem.

Exemplo

Copiarcurl -s "https://sysimb.imbranet.com.br/api/v1/area_validar.php" \
  -H "Authorization: Bearer SUA_CHAVE"

Copiarconst r = await fetch('https://sysimb.imbranet.com.br/api/v1/area_validar.php', {
  method: 'POST',
  headers: { 'Authorization': 'Bearer SUA_CHAVE' }
});
const data = await r.json();
console.log(data);

Copiar<?php
$ch = curl_init('https://sysimb.imbranet.com.br/api/v1/area_validar.php');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer SUA_CHAVE'],
]);
$resp = json_decode(curl_exec($ch), true);
print_r($resp);

Resposta

Copiar{
  "ok": true,
  "data": {
    "consulta_por": "gps",
    "lat": -27.00425303,
    "lng": -48.62140596,
    "dentro": true,
    "areas": [
      { "id": 3, "nome": "BC - Rua 3700", "descricao": null, "cor": "#1976d2" }
    ]
  }
}