Inspetor Local by Softwin Solicitar acesso ↗

Documentação técnica · v1 em compatibilidade

Conecte o Inspetor Local ao seu ecossistema.

Integre equipamentos, inspeções, ordens de retirada, manutenção e testes de mangueiras aos seus sistemas internos, portais e fluxos de revenda.

RESTJSONHTTPS em evolução
request.json
POST /materiais
Content-Type: application/json

{
  "tabela": "Equipamentos",
  "apikey": "SUA_API_KEY",
  "patrimonio": "PAT-0001",
  "empresa": 123
}

Uma base para conectar operação e negócio.

A API atual do Inspetor Local usa uma camada de materiais para receber e consultar dados operacionais. A documentação abaixo organiza o contrato existente para que integradores possam construir conectores, painéis e automações com segurança.

Base atualhttp://api.inspetorlocal.com.br:500/materiais
FormatoJSON com UTF-8
EscritaPOST com campos da tabela
ConsultaGET por filtros de empresa
Nota de compatibilidadeEste é o contrato legado documentado no Inspetor Local. A nova plataforma deverá publicar uma versão versionada, com HTTPS obrigatório, escopos de acesso e cabeçalho de autenticação.

Uma chave por integração.

No contrato atual, a autenticação usa o parâmetro apikey, com uma chave única de 36 caracteres. A chave deve ser tratada como segredo e nunca ficar exposta em aplicativo móvel, navegador ou repositório público.

Variáveis de ambiente
# nunca publique esta chave no frontend
INSPETOR_API_KEY=SUA_CHAVE_DE_36_CARACTERES
INSPETOR_EMPRESA=123
INSPETOR_REGIAO=1
INSPETOR_CIDADE=1

O mesmo ponto de entrada para fluxos diferentes.

POST/materiais

Envia registros de uma tabela operacional.

GET/materiais?equipamentos=1&inspecoes=1&itens=1

Consulta equipamentos, inspeções e itens marcados para manutenção.

Exemplo em cURL
curl -X POST \
  http://api.inspetorlocal.com.br:500/materiais \
  -H 'Content-Type: application/json' \
  -d '{"tabela":"PECAS","apikey":"SUA_API_KEY","patrimonio":"PAT-0001","descricao":"Manômetro","quantidade":1,"empresa":123,"regiao":1,"cidade":1}'
Vários ambientes, um mesmo contratoVeja abaixo exemplos prontos para linguagens de backend e softwares de integração.Ver exemplos de uso ↘

Escolha o seu ambiente. O contrato continua o mesmo.

Integre do jeito que sua equipe já trabalha. O endereço atual recebe JSON em POST /materiais; ajuste a tabela e os campos de acordo com o recurso que será integrado.

Antes de começarUse uma chave de teste em variável de ambiente. Os exemplos usam dados fictícios e a empresa 123 apenas como referência.Ver autenticação ↗
JS

JavaScript / Node.js

fetch
const response = await fetch('http://api.inspetorlocal.com.br:500/materiais', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    tabela: 'PECAS',
    apikey: process.env.INSPETOR_API_KEY,
    patrimonio: 'PAT-0001', descricao: 'Manômetro',
    quantidade: 1, empresa: 123, regiao: 1, cidade: 1
  })
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
PY

Python

requests
import os, requests

payload = {
  'tabela': 'PECAS',
  'apikey': os.environ['INSPETOR_API_KEY'],
  'patrimonio': 'PAT-0001', 'descricao': 'Manômetro',
  'quantidade': 1, 'empresa': 123, 'regiao': 1, 'cidade': 1
}
response = requests.post(
  'http://api.inspetorlocal.com.br:500/materiais',
  json=payload, timeout=20
)
response.raise_for_status()
print(response.json())
PHP

PHP

cURL
$payload = [
  'tabela' => 'PECAS',
  'apikey' => getenv('INSPETOR_API_KEY'),
  'patrimonio' => 'PAT-0001', 'descricao' => 'Manômetro',
  'quantidade' => 1, 'empresa' => 123, 'regiao' => 1, 'cidade' => 1
];
$ch = curl_init('http://api.inspetorlocal.com.br:500/materiais');
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_RETURNTRANSFER => true
]);
$result = curl_exec($ch);
C#

C# / .NET

HttpClient
using var client = new HttpClient();
var payload = new {
  tabela = "PECAS",
  apikey = Environment.GetEnvironmentVariable("INSPETOR_API_KEY"),
  patrimonio = "PAT-0001", descricao = "Manômetro",
  quantidade = 1, empresa = 123, regiao = 1, cidade = 1
};
using var response = await client.PostAsJsonAsync(
  "http://api.inspetorlocal.com.br:500/materiais", payload);
response.EnsureSuccessStatusCode();
JAVA

Java

HttpClient
HttpClient client = HttpClient.newHttpClient();
String json = "{\"tabela\":\"PECAS\",\"apikey\":\"SUA_API_KEY\",\"patrimonio\":\"PAT-0001\",\"empresa\":123}";
HttpRequest request = HttpRequest.newBuilder(
    URI.create("http://api.inspetorlocal.com.br:500/materiais"))
  .header("Content-Type", "application/json")
  .POST(HttpRequest.BodyPublishers.ofString(json)).build();
HttpResponse<String> response = client.send(
  request, HttpResponse.BodyHandlers.ofString());
PS

PowerShell

Invoke-RestMethod
$body = @{
  tabela = 'PECAS'; apikey = $env:INSPETOR_API_KEY
  patrimonio = 'PAT-0001'; descricao = 'Manômetro'; quantidade = 1
  empresa = 123; regiao = 1; cidade = 1
} | ConvertTo-Json

Invoke-RestMethod `
  -Uri 'http://api.inspetorlocal.com.br:500/materiais' `
  -Method Post -ContentType 'application/json' -Body $body

Leve os dados para o fluxo que já existe.

Use a API como uma camada de integração entre o Inspetor Local e os softwares que sua empresa já utiliza.

PM

Postman

Crie uma requisição POST para /materiais, adicione Content-Type: application/json e use variáveis de ambiente para chave e escopo.

  1. Nova requisição
  2. Corpo → bruto → JSON
  3. Enviar e validar retorno
n8n

n8n / Make

Use o módulo de requisição HTTP para disparar o envio e conecte o resultado a CRM, e-mail, planilha ou fila de atendimento.

  1. Requisição HTTP
  2. Corpo JSON
  3. Próximo passo
BI

Power BI / Excel

Para consultas, use o endpoint GET no conector Web ou Power Query e mantenha a credencial protegida no ambiente de dados.

  1. Obter dados da Web
  2. Aplicar parâmetros
  3. Atualizar indicadores
ERP

ERP, CRM ou portal próprio

Crie um conector no seu servidor para traduzir o modelo do software para Equipamentos, Andamento, Ordem, PECAS ou TesteMG.

  1. Mapear campos
  2. Validar dados
  3. Registrar retorno
APP

Aplicativo móvel

O aplicativo deve falar com o seu servidor, nunca diretamente com a API usando a chave. Assim você controla sessão, permissões e sincronização.

  1. Aplicativo envia ao servidor
  2. Servidor autentica
  3. API recebe o registro
API

Função sem servidor

Uma função em nuvem pode receber o evento, validar o contrato e encaminhar a chamada sem expor credenciais no cliente.

  1. Receber evento
  2. Validar dados
  3. Enviar com segurança
Próxima evoluçãoNa nova plataforma, os exemplos serão publicados também com SDKs, OpenAPI, HTTPS obrigatório, webhooks e autenticação por escopo.Falar com a equipe ↗

Tabelas que representam a operação.

Equipamentos

Cadastro e rastreabilidade

Patrimônio, série, fabricante, tipo, capacidade, localização, próximos testes, inspeções, recargas e status.

Campos de referência: patrimonio, numero_serie, localizacao, tipo, proxima_inspecao.
Andamento

Etapas da ordem de serviço

Triagem, rastreabilidade, testes, recargas, inspeções, selagem, expedição e datas de liberação.

Campos de referência: numero_retirada, triagem, data_triagem, data_finalizacao.
Ordem

Ordem de retirada

Cliente, veículo, placa, aprovação, retirada, entrada, saída, nota fiscal e transporte.

Campos de referência: numero_ordem, codigo_cliente, veiculo, data_retirada.
PECAS

Peças substituídas

Trocas vinculadas ao patrimônio, lote, valor, quantidade, garantia e motivo.

Campos de referência: codigo_peca, descricao, valor_peca, data_troca.
TesteMG

Testes de mangueiras

Identificação, classe, diâmetro, ensaio hidrostático, aprovações, substituições e próximas manutenções.

Campos de referência: identificacao, classe, pressao_ensaio, resultado_final_aprov.

Validações simples para dados consistentes.

Datasdd/mm/yyyy para eventos e mm/yyyy para ciclos de fabricação, teste, inspeção e manutenção.
BooleanosCampos do tipo bit usam 1 para sim e 0 para não.
Escopoempresa, regiao e cidade delimitam a origem do registro.
TextoRespeite o tamanho indicado por campo e envie JSON com Content-Type correto.
Boas práticas para integradoresFaça o envio pelo servidor, valide os campos antes da requisição, registre o retorno e mantenha uma fila de reprocessamento para falhas temporárias.

Uma plataforma que também pode ser distribuída.

O módulo de afiliados já possui a base para uma operação de revenda: cada parceiro recebe um link próprio, acompanha empresas vinculadas, visualiza comissões e pode trabalhar com cupons.

01 Link individual de indicação02 Empresas vinculadas03 Comissão disponível04 Cupons e campanhas
Quero integrar ou revender ↗