🔑 Informe sua chave de teste
vaziaEscolha o ambiente, cole a API key e valide. Só ficam liberados os testes dos escopos que a chave tem no SysIMB.
Os testes abaixo usam o ambiente marcado. Endereços aceitos: https em imbranet.com.br ou rgxlabs.app.br; http ou https em 192.168.200.30 (rede interna).
✓ Chave válida · ·
① GET /healthcheck.php
Verifica disponibilidade do serviço.
② GET /ping.php
Valida credenciais e retorna identidade/scopes/IP.
③ POST /spc_consultar.php
Consulta CPF ou CNPJ no SPC Brasil (registros, score, dívidas).
O tipo é detectado pelo tamanho — 11 dígitos = CPF, 14 = CNPJ. Enviado no parâmetro cpf em ambos os casos.
④ POST /area_validar.php
Tem viabilidade, existe prédio de fibra no endereço e qual o prazo de instalação.
Prioridade: lat+lng > cep > endereco. Resposta simplificada por padrão; detalhado=1 traz a consulta completa (caixas, rota, prédio e critério do prazo).
⑤ GET /setores_listar.php
Lista os setores da organização (Suporte, Vendas, etc.).
⑥ POST /operador_consultar.php
Retorna dados do operador (setor, ramal, celular, admissão…) pelo login.
⑦ GET /operadores_buscar.php
Acha operadores por pedaço do nome ou pelo celular — para descobrir o login (o ⑥ exige) ou quem está com um número da empresa.
Lista de até 50. Celular comparado pelos 8 últimos dígitos (aceita máscara, DDI e DDD). Na busca por celular, meta.linhas_da_empresa diz se a linha está atribuída, sem dono ou com dono inativo.
⑧ POST /predio_consultar.php
Retorna prédios cadastrados no endereço/CEP (ex.: MDU, condomínios com ONU).
Prioridade: endereco > cep.
⑨ POST /plano_consultar.php
Consulta um plano pelo ID Vigo (descrição, valor, ICMS, pacote, status e planos incluídos).
O "ID Vigo" mostrado na tela de Planos Vigo. Também aceito como id_plano_vigo.
📁 Cadastro de Cliente
Fluxo sugerido: ⑩ contexto → ⑪ endereço → ⑫ documento → ⑬ pré-cadastro → ⑭ consulta. As respostas de ⑩, ⑪ e ⑫ podem ser importadas no formulário do ⑬.
⑩ GET /cadastro_contexto.php
Base/grupo Vigo de destino no dia, pacotes com inclusos, opcionais e valores aceitos nos campos fechados.
⑪ POST /endereco_resolver.php
Padroniza um endereço no formato do Vigo (Title Case, cidade em MAIÚSCULAS, CEP com máscara).
Informe um entre CEP, endereço ou lat+lng.
⑫ POST /cliente_documento_ler.php
Lê RG/CNH por IA e devolve os campos já no formato do cadastro. Nada é gravado.
No RG é o verso que traz CPF, filiação e naturalidade — envie os dois lados. JPG, PNG, WEBP ou PDF, até 20 MB.
⑬ POST /cliente_pre_cadastrar.php
Padroniza e enfileira o cadastro como pré-cadastro (um operador confere e efetiva no Vigo).
Enviado como JSON tipado. simular=1 valida sem enfileirar e responde 200 mesmo quando inválido — o veredito é o campo valido.
🧩 JSON extra — campos avançados, mesclados por cima do formulário
Ex.: representantes [{nome, cpf, telefone, email}], tel_internacional + tel_intl_ddi + tel_intl_numero,
logradouro + numero, cob_*, documentos (estes dois últimos citados nos erros do manual, sem formato documentado).
⑭ GET /cliente_pre_consultar.php
Situação de um pré-cadastro: aguardando conferência ou efetivado (com o ID do cliente no Vigo).
Cada chave só enxerga os pré-cadastros que ela enviou. Descartado na conferência → 404.
📁 App do Técnico — Atendimentos
Fluxo sugerido: ⑮ login do técnico → ⑱ opções → ⑲ lista → ⑳ consulta → ㉑ cliente → ㉒ abrir / ㉓ atualizar / ㉔ encerrar → ㉕ anexar.
Do ⑯ em diante vão dois headers: a chave da aplicação (Authorization) e o token do técnico (X-Tecnico-Token).
base: 1 = Vigo 01, 2 = Vigo 02 — os ids de tipo, setor, funcionário, cliente e atendimento são de cada base.
🔐 Token do técnico X-Tecnico-Token
vazio
Vale 15 dias, só junto da chave que fez o login. Um por ambiente; fica salvo junto das chaves quando "Lembrar" está marcado.
⑮ POST /tecnico_login.php
O técnico entra com o usuário e a senha do SysIMB. Devolve o token (vai para o campo acima), o id dele em cada base e o que pode fazer (pode).
10 senhas erradas em 15 min bloqueiam só aquele usuário (429). A senha não é guardada aqui.
⑯ GET /tecnico_sessao.php
Confere se o token ainda vale e devolve o mesmo perfil do login (sem token novo). 401 = entrar de novo.
⑰ POST /tecnico_logout.php
Encerra o login: o token deixa de valer na hora (e é apagado do campo acima).
⑱ GET /atendimento_opcoes.php
Tipos, setores e funcionários que podem ser responsáveis, por base.
A resposta vira sugestão nos campos tipo_id, setor_id e responsavel_id dos testes abaixo.
⑲ GET /atendimentos_listar.php
Sem filtro: os atendimentos abertos do técnico logado, das duas bases, na ordem do agendamento — a lista do dia.
cliente, setor_id, tipo_id, responsável por id e página 2+ exigem base. Encerrados de todos exigem cliente ou período.
⑳ GET /atendimento_consultar.php
O atendimento completo, com histórico (historico_cliente é o que pode ser mostrado ao cliente) e a lista de anexos.
Por id (com base) ou por numero_os (procura nas duas). Preenche base, id e cliente nos testes ㉑ a ㉗.
㉑ GET /atendimento_cliente.php
O que o técnico precisa do cliente em campo: situação, Central do Assinante, planos e cada login PPPoE (senha, online, IP, MAC, banda).
⚠ A resposta traz senhas do cliente. Se o RADIUS não responder, acessos vem null.
㉒ POST /atendimento_abrir.php
Abre o atendimento no Vigo com as regras da ficha do cliente (bloco INFORMACOES UTEIS + agendamento). Sem responsavel_id, o responsável é o técnico.
Mesma descrição no mesmo cliente em 2 min → 409 duplicado. Emoji é removido (texto_ajustado). Exige a permissão consultas_abrir_os (a do app, app_tecnico_usar, não abre OS).
㉓ POST /atendimento_atualizar.php
Acrescenta o bloco "--- Atualização ---" ao histórico; opcionalmente reagenda e troca tipo, descrição ou responsável. Campo vazio = mantém.
Só atendimento aberto e só o RESPONSÁVEL (403 nao_responsavel). Reenvio igual → 200 com ja_registrado. Permissão: app_tecnico_usar ou consultas_editar_os.
㉔ POST /atendimento_encerrar.php
Encerra com as regras da ficha do cliente: data, hora, "fechado por" e o bloco "--- Fechamento ---" com o texto.
Só o RESPONSÁVEL. Encerrar de novo → 409. subiu_poste=1 registra a análise preliminar de risco. Permissão: app_tecnico_usar ou consultas_fechar_os.
㉕ POST /atendimento_anexo_enviar.php
Anexa foto, vídeo, assinatura ou PDF (multipart). Atendimento encerrado também recebe anexo. Só o RESPONSÁVEL.
JPG, PNG e PDF até 10 MB; MP4, MOV, 3GP e WEBM até 150 MB. O tipo é conferido pelo conteúdo. Resposta 201.
㉖ GET /atendimento_anexo_baixar.php
Devolve o arquivo (não JSON) — aqui aparece a prévia e o botão de baixar. Os erros continuam em JSON.
O id vem em anexos do ⑳ consulta.
㉗ POST /atendimento_anexo_excluir.php
Apaga um anexo — só o RESPONSÁVEL e só de atendimento aberto (depois de encerrado, o anexo faz parte do registro).
💲 App do Técnico — Valores de Serviços
Quanto cobrar por serviço em campo (Administrativo → Valores de Serviços). O app só lê. Só a chave, sem o token do técnico (se for enviado, é ignorado).
O app guarda a lista com todos=1 e só baixa de novo quando meta.atualizado_em muda; mostra só os itens com "ativo": true.
㉘ GET /servicos_valores_listar.php
A tabela de valores: valor padrão, unidade (hora, metro ou unidade) e, se houver, uma variação com preço próprio (ex.: Rural). Sem parâmetros, só os ativos, em ordem de nome.
Valores em decimal com ponto ("3.00"); abaixo da resposta aparece a tabela formatada em pt-BR, como o app deve mostrar.
㉙ GET /servico_valor_consultar.php
Um serviço pelo ID, no mesmo formato de cada item da lista. Devolve também o inativo ("ativo": false) — o app não deve oferecê-lo para cobrança.
O ㉘ preenche as sugestões de ID.
📦 Estoque
Fluxo sugerido: ㉚ consulta o produto (saldo por local e api.permite_baixa) → ㉛ ajusta. A consulta preenche o ID e os locais do ㉛; o ⑮ login preenche o operador_login do ㉛ e do ㉜.
Só aparecem os produtos liberados pela IMBRANET ("🔌 Disponível via API"); os outros dão 403 produto_nao_liberado.
㉚ GET /estoque_produto_consultar.php
Produto do estoque pelo ID da tela Produtos: cadastro, categoria, saldo total e por local físico, situação diante do mínimo/padrão, última compra, valor de venda e produtos do Vigo vinculados.
situacao: zerado, critico (≤ mínimo), baixo (< padrão) ou ok. A Reserva Funcionário não entra no total. valor_venda (a_vista/a_prazo) ≠ vigo[].preco_venda. api.permite_baixa = false → o app esconde a baixa.
㉛ POST /estoque_ajustar.php
O mesmo Ajuste da tela Estoque: grava um movimento com motivo, saldo anterior e novo. Nenhum local pode ficar negativo.
Informe um entre quantidade (saldo final) e variacao (+5, −2). Com a mesma referencia o reenvio não lança de novo ("repetido": true).
Produto sem "📉 API permite baixa no estoque" → 403 produto_sem_baixa_api, nada gravado.
Rode o ㉚ para preencher o ID e ver os locais com saldo.
㉜ GET /estoque_funcionarios_listar.php
Equipamentos com funcionários (a tela Estoque com Funcionários): reserva, uso no trabalho e empréstimo, com a situação de cada um. Sem status, só o que está em mãos.
Filtrando um funcionário vem também o kit padrão (quanto deve ter, tem e falta repor). pendencias=1 traz empréstimos atrasados e reposições. Use funcionario_id ou operador_login, não os dois.