API IMBRANET · v1

Manual de integração para sistemas externos
🧪 Testar no Validador APIs ↗
A chave e o token ficam apenas no seu navegador (para montar os exemplos). Nada é enviado ou armazenado em nossos servidores ao digitá-los — só quando você clica em Testar chave, que apenas valida a credencial. Para testar as chamadas dos endpoints, use o Validador APIs.

🔐 Autenticação

Todas as requisições protegidas exigem o cabeçalho HTTP:

Authorization: Bearer SUA_CHAVE

A base da API é https://sysimb.imbranet.com.br/api/v1/. Use sempre HTTPS. A chave é exibida uma única vez na criação — guarde-a com segurança.

👷 Login do técnico (App do Técnico)

Os endpoints marcados com 👷 token do técnico agem em nome de um técnico, com as permissões do usuário dele no SysIMB. Além da chave, exigem o token devolvido pelo login (os marcados 👷 aceita token do técnico funcionam sem ele, mas com ele o técnico sai do login — não de um parâmetro):

  1. Faça POST /api/v1/tecnico_login.php com login e senha do SysIMB (com a chave no Authorization). Guarde o token da resposta.
  2. Envie os dois headers nas chamadas seguintes:
Authorization: Bearer SUA_CHAVE
X-Tecnico-Token: TOKEN_DO_TECNICO

O token vale 15 dias e só junto da chave que fez o login. Resposta 401 com código tecnico_* = mandar o técnico para a tela de login. No "Sair" do app, chame tecnico_logout.

📦 Formato do envio

MétodoComo enviar os parâmetros
GETNa query string: ?base=1&id=12345
POSTCorpo JSON com Content-Type: application/json (formulário application/x-www-form-urlencoded também é aceito). Listas e objetos vão como JSON.
POST com arquivomultipart/form-data, um campo por parâmetro e o arquivo no campo indicado (ex.: arquivo).

As respostas são sempre JSON — exceto os endpoints marcados com 📎 devolve arquivo, que devolvem o próprio arquivo no sucesso (e JSON no erro). Os exemplos de cada endpoint usam valores fictícios: troque pelos seus.

🧪 Testes

Os testes das chamadas são feitos no nosso validador: Validador APIs ↗. Lá você escolhe o sistema, informa a sua chave e confere cada endpoint com a resposta real.

Este manual serve para consultar os endpoints e copiar os exemplos. O botão Testar chave, no topo, só confirma que a chave é válida e mostra os escopos dela.

65 endpoints
Nenhum endpoint encontrado com esses filtros.

📁 Diagnóstico

GET /api/v1/healthcheck.php público ▶ 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

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

Resposta

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

Erros deste endpoint

HTTPCódigoQuando acontece
503—O banco de dados não respondeu. O corpo continua com ok: true, mas com status "degradado" e banco "falha" — monitore o código HTTP, não só o campo ok.
GET /api/v1/ping.php 🔑 requer chave ▶ 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

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

Resposta

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

📁 SPC Brasil

POST /api/v1/spc_consultar.php 🔑 requer chave · spc:consultar ▶ Consultar CPF ou CNPJ no SPC

Consulta a situação de um CPF (pessoa física) ou CNPJ (pessoa jurídica) no SPC Brasil (restrição, score, protestos, ações, cheques, pendências e valor de dívidas).

O documento pode vir em "cpf", "cnpj" ou "documento" — o tipo de pessoa é detectado pelo TAMANHO do documento (11 dígitos = CPF, 14 = CNPJ), então é seguro continuar mandando o CNPJ no campo "cpf". Máscara é aceita e ignorada ("14.923.423/0001-98" = "14923423000198"). Para CNPJ, o campo "nome" traz a razão social.

TODOS os valores do "data" são retornados como string (números e booleanos viram string; null vira ""). tem_restricao = "0" (sem restrição) ou "1" (com restrição).

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. ATENÇÃO ao "resumo.valor_total_dividas": ele NÃO é a soma das seções.

O SPC devolve a mesma dívida em duas listas (registros SPC e pendências financeiras), com o mesmo número de contrato — cada contrato entra UMA vez no total, pelo maior valor. Protestos e cheques não trazem contrato e entram integralmente. Somar as quantidades × valores das seções dá um número maior, e errado.

Parâmetros

NomeTipoObrigatórioDescrição
cpfstringSimDocumento do consumidor: CPF ou CNPJ, com ou sem máscara. Os nomes "cnpj" e "documento" também são aceitos para o mesmo parâmetro.
consulta_novainteiroNão1 = consulta nova direto no SPC; 0 ou ausente = usa o histórico do SysIMB antes (padrão 0).
detalhadointeiroNão1 = inclui também a resposta bruta do SPC em "spc_raw".

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/spc_consultar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "cpf": "123.456.789-09"
}'

Resposta

{
  "ok": true,
  "data": {
    "cpf": "12345678900",
    "documento": "12345678900",
    "documento_formatado": "123.456.789-00",
    "tipo_pessoa": "F",
    "consulta_nova": "0",
    "origem": "historico",
    "consultado_em": "2026-06-25 10:00:00",
    "ambiente": "producao",
    "protocolo": "2026062301234567",
    "nome": "FULANO DE TAL",
    "tem_restricao": "0",
    "score": "712",
    "score_classe": "Verde",
    "score_mensagem": "",
    "resumo": {
      "registros_spc": "0",
      "protestos": "0",
      "acoes": "0",
      "cheques": "0",
      "pendencias_financeiras": "0",
      "alertas_documento": "0",
      "consultas_recentes": "3",
      "valor_total_dividas": "0"
    },
    "consulta_id": "1016"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de GET e POST.
400cpf_ausenteNenhum documento em cpf, cnpj ou documento.
400documento_invalidoO documento não tem 11 (CPF) nem 14 (CNPJ) dígitos.
400cpf_invalidoCPF com dígito verificador inválido.
400cnpj_invalidoCNPJ com dígito verificador inválido.
422spc_erroO SPC recusou a consulta (ex.: documento que o SPC não aceita). erro.spc_codigo traz o código devolvido pelo SPC. Repetir a chamada não muda o resultado.
503spc_indisponivelO SPC Brasil está fora do ar ou não respondeu a tempo — o SysIMB já tentou de novo sozinho antes de devolver o erro (erro.tentativas), e erro.detalhe traz o motivo técnico. Não é problema da chave nem do documento: repita a chamada depois do tempo do header Retry-After (60 s). Nesse caso a resposta pode levar até uns 35 segundos — use um tempo limite maior que isso. O mesmo código vem, sem detalhe, quando a integração com o SPC está desativada ou sem credencial no SysIMB.

📁 Cobertura

POST /api/v1/area_validar.php 🔑 requer chave · cobertura:consultar ▶ Validar viabilidade e prazo de instalação

Responde três perguntas sobre um endereço: TEM VIABILIDADE, EXISTE PRÉDIO de fibra cadastrado nele e QUAL O PRAZO de instalação. Informe o ponto por endereço, CEP ou GPS (lat+lng; prioridade: GPS > CEP > endereço). Aceita GET ou POST.

Por padrão a resposta é CURTA — o que um atendimento ou um robô precisa para responder ao cliente (campos na tabela abaixo).

Para a consulta completa (caixas e portas do Geogridmaps, rota pela rua, todas as áreas e o critério do prazo), envie detalhado=1 — é a mesma informação da tela de validação do SysIMB. A consulta é a mesma nos dois formatos: só muda o que volta.

REGRA DO

PRAZO: (1) Cidade ou região fora das áreas de cobertura, ou área marcada sem viabilidade = sem viabilidade, sem prazo; em áreas sobrepostas vale sempre a MENOR.

(2) Prédio cadastrado decide pelo prédio: ativo + cabo de rede ou ONU apto + NOC Não = Prazo Prédio; ativo + NOC Sim = Prazo NOC; ativo + tipo casa = Prazo Casa; inativo ou em ativação + NOC Sim = Prazo NOC; prédio marcado sem viabilidade = sem viabilidade; demais = Nova Instalação. (3) Apartamento em prédio não cadastrado (tipo_local=apartamento) = Nova Instalação.

(4) Casa: Prazo Reduzido só com porta livre (CA ou CE) a até 300 m PELA RUA; sem porta livre no raio, acima de 300 m, ou quando o mapa não consegue traçar a rota pela rua = Nova Instalação. Nome e dias de cada prazo vêm do cadastro de Regras de Venda do SysIMB.

ATENÇÃO: até a versão 1.12.1345 a resposta padrão era a completa. Quem lê campos como com_viabilidade, viabilidade, rota ou prazo.criterio passa a enviar detalhado=1.

Também saíram os parâmetros rural e esquinas (o prazo sai só do mapa), o bloco prazo.cenarios e o campo sob_agenda; o Prazo Prédio agora traz os dias cadastrados; e endereço numa cidade que não atendemos responde tem_viabilidade=false em vez do erro geocode_falhou.

Parâmetros

NomeTipoObrigatórioDescrição
latnúmeroNãoLatitude (use junto com lng).
lngnúmeroNãoLongitude (use junto com lat).
cepstringNãoCEP (com ou sem máscara). Usado se lat/lng não vierem.
enderecostringNãoEndereço livre. Usado se lat/lng e cep não vierem. Formato: rua e número, cidade (ex.: "Rua Silveira 110, Camboriú"). Geocodificado com a mesma inteligência da tela (Google + Nominatim restrito às cidades atendidas), tolerando endereço parcialmente errado. Resultado que só acha a cidade (rua inexistente) é recusado com geocode_falhou. Se não localizar, a resposta de erro pode trazer "sugestao" (você quis dizer) com rotulo/lat/lng.
raiointeiroNãoRaio em metros para a viabilidade. Padrão: raio cadastrado no sistema.
viabilidadeinteiroNão0 desativa a consulta de portas (retorna só a área). Sem portas consultadas, o prazo da casa é Nova Instalação. Padrão 1.
rotainteiroNão0 não calcula a distância pela rua (usa a linha reta do Geogrid). Sem rota pela rua, o prazo da casa é Nova Instalação. Padrão 1.
tipo_localstringNão"casa" ou "apartamento". Apartamento sem prédio cadastrado vira Nova Instalação; "casa" ignora prédio achado no endereço. Sem ele: prédio achado = regra do prédio; senão, regra da casa.
detalhadointeiroNão1 = resposta completa (área, caixas do Geogrid com as portas, rota, prédio e o prazo com o critério). Padrão 0: resposta curta.
predio_idinteiroNãoID do prédio de fibra (o mesmo de predio_consultar). Use quando o endereço casar com mais de um prédio, ou quando consultar só por coordenada.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/area_validar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "endereco": "Rua Exemplo 400, Camboriú"
}'

Resposta (padrão) — casa com porta livre perto

{
  "ok": true,
  "data": {
    "endereco": "R. Exemplo, 400 - Centro, Camboriú - SC, 88340-000, Brasil",
    "lat": -27.0301,
    "lng": -48.6502,
    "tem_viabilidade": true,
    "area": "CAMBORIÚ",
    "predio": null,
    "prazo": {
      "status": "definido",
      "nome": "Prazo Reduzido",
      "dias_uteis": 2,
      "texto": "Prazo Reduzido — 2 dia(s) útil(eis)",
      "motivo": "Porta livre a 192 m pela rua (CA 01). Até 300 m pela rua."
    }
  }
}

Campos da resposta

CampoTipoO que é
enderecostring|nullComo o mapa entendeu o endereço. Confira se achou o lugar certo. null na consulta por GPS.
lat, lngnúmeroCoordenada usada na consulta.
tem_viabilidadebooltrue = atendemos o endereço e dá para vender. false = fora da área de cobertura, área sem viabilidade ou prédio sem viabilidade.
areastring|nullÁrea de cobertura que decidiu (a menor, quando há sobreposição). null fora das áreas.
predioobjeto|nullPrédio de fibra cadastrado no endereço: id, nome, status (Ativo, Em ativação, Inativo, Sem viabilidade) e tipo_instalacao (ONU Apto, Cabo Rede, Tipo Casa). null quando não há.
prazo.statusstringdefinido (tem prazo) | sem_viabilidade (não há prazo a prometer) | a_confirmar (o endereço casou com mais de um prédio: repita com predio_id) | sem_regra (a regra que valeria está inativa em Regras de Venda).
prazo.nomestring|nullNome do prazo em Regras de Venda (Prazo Reduzido, Nova Instalação, Prazo Prédio, Prazo NOC, Prazo Casa).
prazo.dias_uteisinteiro|nullDias úteis cadastrados para esse prazo. null quando não há prazo.
prazo.textostringFrase pronta para mostrar ao cliente.
prazo.motivostringPor que esse prazo (porta livre e distância, regra do prédio, fora da área…). Para conferência interna.
predioslistaSó com prazo.status=a_confirmar: os prédios que casaram com o endereço (id, nome). Repita a consulta com o predio_id escolhido.

Resposta — prédio cadastrado

O endereço é de um prédio de fibra: o prazo segue o status, o tipo de instalação e a consulta NOC do prédio.

{
  "ok": true,
  "data": {
    "endereco": "Av. Exemplo, 112 - Centro, Camboriú - SC, 88340-000, Brasil",
    "lat": -27.0255,
    "lng": -48.6533,
    "tem_viabilidade": true,
    "area": "CAMBORIÚ",
    "predio": {
      "id": 10,
      "nome": "Edifício Exemplo",
      "status": "Ativo",
      "tipo_instalacao": "ONU Apto"
    },
    "prazo": {
      "status": "definido",
      "nome": "Prazo Prédio",
      "dias_uteis": 2,
      "texto": "Prazo Prédio — 2 dia(s) útil(eis)",
      "motivo": "Prédio Ativo, ONU Apto, consulta NOC: Não"
    }
  }
}

Resposta — sem viabilidade

Cidade que não atendemos, área marcada sem viabilidade ou prédio sem viabilidade.

{
  "ok": true,
  "data": {
    "endereco": "R. Exemplo, 100 - Centro, Blumenau - SC, 89010-000, Brasil",
    "lat": -26.92,
    "lng": -49.06,
    "tem_viabilidade": false,
    "area": null,
    "predio": null,
    "prazo": {
      "status": "sem_viabilidade",
      "nome": null,
      "dias_uteis": null,
      "texto": "Sem viabilidade — não há prazo a prometer.",
      "motivo": "Fora das áreas de cobertura (cidade ou região que não atendemos)."
    }
  }
}

Resposta — mais de um prédio no endereço

Repita a consulta com predio_id (um dos ids de "predios") para sair o prazo.

{
  "ok": true,
  "data": {
    "endereco": "R. Exemplo, 50 - Centro, Camboriú - SC, 88340-000, Brasil",
    "lat": -27.027,
    "lng": -48.649,
    "tem_viabilidade": true,
    "area": "CAMBORIÚ",
    "predio": null,
    "prazo": {
      "status": "a_confirmar",
      "nome": null,
      "dias_uteis": null,
      "texto": "O endereço casou com mais de um prédio: repita a consulta com predio_id.",
      "motivo": "O endereço casou com mais de um prédio cadastrado — informe predio_id."
    },
    "predios": [
      {
        "id": 10,
        "nome": "Edifício Exemplo - Bloco A"
      },
      {
        "id": 11,
        "nome": "Edifício Exemplo - Bloco B"
      }
    ]
  }
}

Resposta completa (detalhado=1)

Mesma consulta, com tudo o que a tela de validação mostra. caixas: itens do Geogridmaps no raio, do mais perto para o mais longe em linha reta (item terminal = CA, caixa = CE). rota: distância pela rua até a caixa com porta livre mais próxima, desviando das áreas sem poste; sem rota, vem a linha reta com linha_reta=true e o motivo. prazo.criterio: a explicação da decisão.

{
  "ok": true,
  "data": {
    "consulta_por": "endereco",
    "lat": -27.0301,
    "lng": -48.6502,
    "dentro": true,
    "com_viabilidade": true,
    "sobreposta": false,
    "areas": [
      {
        "id": 23,
        "nome": "CAMBORIÚ",
        "descricao": "Venda padrão",
        "tem_viabilidade": 1,
        "cor": "#1976d2"
      }
    ],
    "viabilidade": {
      "disponivel": true,
      "raio": 200,
      "total_caixas": 2,
      "portas_livres_total": 3,
      "tem_porta_livre": true,
      "caixas": [
        {
          "id": "1001",
          "sigla": "CA 01",
          "item": "terminal",
          "lat": -27.031,
          "lng": -48.6505,
          "distancia": 128,
          "statusViabilidade": "possui",
          "possuiAtendimento": "S",
          "portasLivres": 3,
          "portasOcupadas": 13,
          "portasReservadas": 0,
          "portas": 16,
          "ocupacaoPortas": 81,
          "fibrasLivresLuz": 0
        },
        {
          "id": "1002",
          "sigla": "CE 02",
          "item": "caixa",
          "lat": -27.029,
          "lng": -48.652,
          "distancia": 175,
          "statusViabilidade": "limitada",
          "possuiAtendimento": "N",
          "portasLivres": 0,
          "portasOcupadas": 2,
          "portasReservadas": 0,
          "portas": 2,
          "ocupacaoPortas": 100,
          "fibrasLivresLuz": 0
        }
      ]
    },
    "rota": {
      "calculada": true,
      "caixa_id": "1001",
      "sigla": "CA 01",
      "distancia": 192,
      "linha_reta": false,
      "trecho_interno": 21,
      "areas_evitadas": 3,
      "motivo": null
    },
    "predio": {
      "consultado": true,
      "total": 0,
      "predios": [],
      "selecionado": null,
      "motivo": null
    },
    "prazo": {
      "status": "definido",
      "caminho": "casa",
      "prazo": {
        "referencia": "prazo_menor",
        "nome": "Prazo Reduzido",
        "dias_uteis": 2,
        "descricao": "Prazo curto de instalação - Quando há portas disponíveis",
        "texto": "Prazo Reduzido — 2 dia(s) útil(eis)"
      },
      "criterio": [
        "Porta livre a 192 m pela rua (CA 01).",
        "Até 300 m pela rua."
      ],
      "pendentes": []
    },
    "rotulo": "R. Exemplo, 400 - Centro, Camboriú - SC, 88340-000, Brasil"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_ausenteNenhum ponto informado (lat+lng, cep ou endereco).
400coordenada_invalidaCoordenada fora do intervalo ou 0,0.
400tipo_local_invalidotipo_local diferente de "casa" e "apartamento".
404predio_nao_encontradopredio_id que não existe.
405metodo_invalidoMétodo diferente de GET e POST.
422geocode_falhouCEP ou endereço não localizado. Também quando o endereço só foi achado no nível da CIDADE (rua inexistente ou digitada errada): o ponto seria o centro do município, então é recusado em vez de responder dentro/fora e prazo de lá. Com endereço, a resposta pode trazer "sugestao" (você quis dizer: rotulo, lat, lng) ao lado de "erro".
500erro_internoFalha na consulta espacial das áreas.
POST /api/v1/predio_consultar.php 🔑 requer chave · predios:consultar ▶ Consultar prédio de fibra por endereço

Verifica se um endereço corresponde a um prédio de fibra já cadastrado, retornando tipo de instalação (ONU Apto / Cabo Rede / Tipo Casa), status (ativo / em ativação / inativo / sem viabilidade), mensagem de alerta e se precisa consultar o NOC. Informe endereco (melhor precisão — inclua rua e número) ou cep. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
enderecostringNãoEndereço a consultar (inclua rua e número para melhor precisão).
cepstringNãoCEP; usado se endereco não vier (resolve rua/bairro/cidade). Menos preciso, sem número.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_consultar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "endereco": "Rua Exemplo, 100, Centro, Itajai - SC"
}'

Resposta

{
  "ok": true,
  "data": {
    "consulta_por": "endereco",
    "endereco_consultado": "Rua Brusque 500, Centro, Camboriu",
    "tem_predio": true,
    "total": 1,
    "predios": [
      {
        "id": 42,
        "nome": "Ed. Exemplo",
        "endereco1": "Rua Brusque, 500",
        "endereco2": null,
        "bloco": "",
        "endereco_vigo": "Rua Brusque 500",
        "bairro": "Centro",
        "cidade": "Camboriu",
        "tipo": "fibra_apartamento",
        "tipo_label": "ONU Apto",
        "tipo_cor": "#2196f3",
        "tipo_icone": "⚡",
        "status": "ativo",
        "status_label": "Ativo",
        "alerta": "",
        "noc": "Não"
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de GET e POST.
400parametro_ausenteNem endereco nem cep vieram.
400endereco_curtoEndereço com menos de 4 caracteres.
422cep_nao_encontradoO CEP não foi localizado.

📁 Organização

GET /api/v1/setores_listar.php 🔑 requer chave · setores:listar ▶ Listar setores

Lista os setores do sistema. Por padrão retorna só os ativos; use todos=1 para incluir os inativos.

Parâmetros

NomeTipoObrigatórioDescrição
todosinteiroNão1 = inclui setores inativos. Padrão 0 (só ativos).

Exemplo

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

Resposta

{
  "ok": true,
  "data": {
    "total": 2,
    "setores": [
      { "id": 3, "nome": "Suporte", "descricao": null, "tecnico": true, "epis": false, "ativo": true }
    ]
  }
}
POST /api/v1/operador_consultar.php 🔑 requer chave · operadores:consultar ▶ Consultar funcionário pelo login do operador

Dado o login de um operador, retorna o e-mail do cadastro do operador e os dados do funcionário vinculado: nome, status do funcionário (ativo/inativo/ferias/afastado), setor, sexo, data de nascimento, data de admissão.

Quando o funcionário está de férias, o objeto "ferias" traz inicio, retorno e dias do período vigente (null caso contrário). Retorna ainda e ramal(is) e celular(es)/WhatsApp cadastrados na Telefonia (só os ativos).

O campo "email" vem do cadastro do operador; quando não há e-mail cadastrado, "email" vem null e "tem_email" false (o operador existindo, a resposta continua ok:true).

São DOIS setores, e eles divergem: "setor" é onde o OPERADOR está cadastrado (é o que vale para quem atende no sistema) e "setor_funcionario" é onde ele está no RH. Até a 1.12.984 o campo "setor" trazia o do funcionário — se você usa esse campo, confira qual dos dois quer.

Cada um traz o mais específico (o subsetor quando houver), com o par separado em "setor_pai"/"subsetor" e "setor_funcionario_pai"/"subsetor_funcionario". Operador sem funcionário vinculado continua tendo "setor"; só os campos de funcionário vêm null.

Se o funcionário estiver INATIVO, a resposta traz apenas login, nome e funcionario_status/label — sem e-mail. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
loginstringSimLogin do operador (operadores.login).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/operador_consultar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "login": "fulano.tecnico"
}'

Resposta

{
  "ok": true,
  "data": {
    "login": "maria.souza",
    "operador_ativo": true,
    "tem_funcionario": true,
    "nome": "Maria de Souza",
    "email": "financeiro@suaempresa.com.br",
    "tem_email": true,
    "funcionario_status": "ferias",
    "funcionario_status_label": "Férias",
    "ferias": {
      "inicio": "2026-07-01",
      "retorno": "2026-07-31",
      "dias": 31
    },
    "setor": "Financeiro",
    "setor_pai": "Administrativo",
    "subsetor": "Financeiro",
    "setor_funcionario": "Cobrança",
    "setor_funcionario_pai": "Administrativo",
    "subsetor_funcionario": "Cobrança",
    "sexo": "F",
    "sexo_label": "Feminino",
    "data_nascimento": "1990-01-15",
    "data_admissao": "2020-02-01",
    "ramal": "1000",
    "ramais": [
      "1000"
    ],
    "celular": null,
    "celulares": []
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de GET e POST.
400parametro_ausenteO parâmetro login não veio.
404operador_nao_encontradoNão existe operador com esse login.
POST /api/v1/operadores_buscar.php 🔑 requer chave · operadores:consultar ▶ Buscar operadores por nome ou celular

Acha operadores por um pedaço do nome ou por um celular — para descobrir o login de alguém (o operador_consultar exige o login) ou quem está hoje com um número da empresa, que passa de quem sai para quem entra. Devolve uma LISTA em "data" (vazia quando ninguém bate), no máximo 50.

O celular é comparado pelos 8 últimos dígitos com os celulares ATIVOS da Telefonia, então aceita máscara, DDI 55, DDD e o nono dígito. Com nome e celular juntos, vale quem bate nos dois. "situacao" é a do funcionário (ativo, ferias, afastado, inativo). Quem tem o celular mas não tem acesso ao sistema aparece com "login": null e "tem_operador": false. Funcionários inativos só vêm com todos=1, e enxutos: sem setor, celular e ramal.

LISTA

VAZIA NA

BUSCA POR

CELULAR NÃO É

AMBÍGUA: quando vem "celular", o meta traz "celular_da_empresa" (o número é de uma linha ativa da empresa?) e "linhas_da_empresa" com a situação de cada linha que bate — "atribuida" (tem funcionário em atividade: é quem aparece em data), "sem_dono" (linha ativa ainda sem funcionário: o chip está trocando de mão) ou "dono_inativo" (ainda no nome de quem saiu). celular_da_empresa = false: o número não é da empresa. Esses dois campos não vêm na busca só por nome. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
nomestringSim, ou celularPedaço do nome (mínimo 3 letras).
celularstringSim, ou nomeCelular com ou sem máscara/DDI (mínimo 8 dígitos).
todosinteiroNão1 = inclui funcionários inativos (resposta enxuta).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/operadores_buscar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "nome": "fulano"
}'

Resposta

{
  "ok": true,
  "data": [
    {
      "login": "maria.souza",
      "nome": "Maria de Souza",
      "situacao": "ativo",
      "situacao_label": "Ativo",
      "tem_operador": true,
      "operador_ativo": true,
      "setor": "Financeiro",
      "celular": "5547990000000",
      "celulares": [
        "5547990000000"
      ],
      "ramal": "1000"
    }
  ],
  "meta": {
    "total": 1,
    "limite": 50,
    "truncado": false,
    "celular_da_empresa": true,
    "linhas_da_empresa": [
      {
        "numero": "5547990000000",
        "situacao": "atribuida"
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de GET e POST.
400parametro_ausenteNem nome nem celular.
400parametro_invalidoNome com menos de 3 letras ou celular com menos de 8 dígitos.

📁 Planos

POST /api/v1/plano_consultar.php 🔑 requer chave · planos:consultar ▶ Consultar plano pelo ID Vigo

Retorna os dados de um plano cadastrado (os mesmos exibidos em Planos Vigo) a partir do seu ID Vigo: descrição, valor, ICMS, nota, nome/tipo do pacote, plano/banda (Radius), status (ativo) e a lista de planos INCLUÍDOS no pacote — cada incluído já resolvido para seu ID Vigo, descrição, valor e status. valor vem como string decimal com 2 casas (ex.: "136.90"). Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimID Vigo do plano (o "ID Vigo" mostrado na tela). Aceita também o nome id_plano_vigo.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/plano_consultar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 123
}'

Resposta

{
  "ok": true,
  "data": {
    "id_plano_vigo": 227,
    "descricao": "2024 - INTERNET DE ATÉ 1 GBPS DE DOWNLOAD NO PACOTE FIBRA 1000",
    "valor": "136.90",
    "icms": true,
    "nota": true,
    "nome_pacote": "PACOTE FIBRA 1000",
    "tipo_pacote": "PACOTE FIBRA",
    "plano_radius": null,
    "ativo": true,
    "incluidos": [
      { "id_plano_vigo": 226, "descricao": "IP FIXO", "valor": "0.00", "ativo": true }
    ],
    "criado_em": "2026-01-10 06:55:00",
    "atualizado_em": "2026-01-10 06:55:00"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de GET e POST.
400parametro_invalidoid (ou id_plano_vigo) ausente ou que não é um inteiro positivo.
404nao_encontradoNão existe plano com esse ID Vigo.
500erro_internoFalha ao consultar o plano.

📁 Cadastro de Cliente

GET /api/v1/cadastro_contexto.php 🔑 requer chave · clientes:cadastrar ▶ Contexto para montar o cadastro

Devolve tudo o que é preciso saber ANTES de montar um cadastro: a base e o grupo Vigo que receberão o cliente hoje (o roteamento muda conforme o dia do mês), o catálogo de pacotes já com os serviços inclusos e seu valor somado, a lista de opcionais, e os valores aceitos em cada campo fechado (tipo de pessoa, sexo, situação, dia de vencimento, DICI). Também informa se a trava de simulação está ligada.

Consulte este endpoint antes de enviar o cadastro — assim você monta o payload com ids de plano válidos e sabe de antemão em que base o cliente vai cair.

Pacote marcado no SysIMB como "apenas para renovação de contrato" não entra na lista (não é venda nova); "velocidade_txt" é a velocidade cadastrada no pacote (download/upload), vazia quando não há; "informacoes_extras" é o texto livre cadastrado no pacote em Planos Vigo (ex.: "IP Público Free"), vazio quando não há.

Parâmetros

NomeTipoObrigatórioDescrição
diainteiroNãoDia do mês (1–31) para simular o roteamento de outro dia. Padrão: hoje.

Exemplo

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

Resposta

{
  "ok": true,
  "data": {
    "destino": {
      "dia": 4,
      "ok": true,
      "base_id": 2,
      "base": "Vigo 02",
      "origem": "faixa",
      "grupo": "GRUPO 28",
      "idempresa": 2
    },
    "pacotes": [
      {
        "id_plano_vigo": 227,
        "nome": "PACOTE FIBRA 1000",
        "tipo": "PACOTE FIBRA",
        "valor": "136.90",
        "valor_total": "189.90",
        "velocidade": "1000",
        "velocidade_txt": "↓ 1 Gbps · ↑ 500 Mbps",
        "apenas_renovacao": false,
        "informacoes_extras": "IP Público Free",
        "incluidos": [
          { "id_plano_vigo": 263, "descricao": "IBTV PLAY", "valor": "19.00" }
        ]
      }
    ],
    "opcionais": [
      { "id_plano_vigo": 42, "nome": "IP FIXO - IPv4", "valor": "100.00" }
    ],
    "dominios": {
      "tipo": { "F": "Pessoa Física", "J": "Pessoa Jurídica" },
      "vencimento": ["10", "15", "20"],
      "dici_atendimento": ["URBANO", "RURAL"]
    },
    "simulacao_forcada": true
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400dia_invalidoO parâmetro "dia" foi enviado fora de 1 a 31.
POST /api/v1/endereco_resolver.php 🔑 requer chave · endereco:resolver ▶ Resolver endereço (CEP, texto ou GPS)

Resolve um endereço a partir do CEP, de um texto livre ("Rua Brusque 100, Camboriú") ou de uma coordenada, e devolve o bloco já padronizado no formato que a base Vigo usa: logradouro por extenso e em Title Case (R. → Rua), bairro sem o prefixo "Bairro", cidade em MAIÚSCULAS, CEP com máscara e o campo endereco montado como "Logradouro Numero Complemento". Também devolve latitude e longitude quando disponíveis. Quando o texto não é encontrado, a resposta pode trazer "sugestao" com o "você quis dizer". Informe UM entre cep, endereco ou lat+lng. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
cepstringNãoCEP com ou sem máscara.
enderecostringNãoEndereço em texto livre. Inclua a cidade para melhor precisão.
latnúmeroNãoLatitude (use junto com lng).
lngnúmeroNãoLongitude (use junto com lat).
numerostringNãoNúmero do imóvel, para compor o campo endereco.
complementostringNãoComplemento (ex.: "Apto 204", "Bl B").

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/endereco_resolver.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "cep": "88300-000",
  "numero": "100"
}'

Resposta

{
  "ok": true,
  "data": {
    "origem": "cep",
    "fonte": "google",
    "endereco": "Rua Eucalipto 52",
    "logradouro": "Rua Eucalipto",
    "numero": "52",
    "complemento": "",
    "bairro": "Tabuleiro",
    "cidade": "CAMBORIU",
    "uf": "SC",
    "cep": "88348-270",
    "latitude": "-26.9989795",
    "longitude": "-48.6545082",
    "aproximado": false
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_ausenteNenhum de "cep", "endereco" ou "lat" + "lng" foi enviado.
404endereco_nao_encontradoO endereço não foi localizado nas cidades atendidas. Quando há um parecido, erro.sugestao traz {nome, cidade, uf, lat, lng, rotulo} (o "você quis dizer"); senão vem null.
POST /api/v1/cliente_documento_ler.php 🔑 requer chave · clientes:documento_ler ▶ Ler documento de identidade (RG/CNH)

Lê a foto de um documento de identidade e extrai nome, CPF, RG, data de nascimento, sexo, filiação e naturalidade — já padronizados no formato do cadastro. Envie a imagem em multipart (campo arquivo) ou em JSON (arquivo_base64, com ou sem prefixo data:). Formatos aceitos: JPG, PNG, WEBP e PDF (primeira página).

Se o documento tiver verso, envie-o também: no RG brasileiro é o verso que traz filiação, naturalidade e CPF, e as duas imagens são analisadas em conjunto.

O resultado é uma SUGESTÃO para conferência: o CPF só vem preenchido se passar no dígito verificador, e campos de leitura duvidosa vêm listados em "avisos". Nada é gravado.

Parâmetros

NomeTipoObrigatórioDescrição
arquivoarquivoNãoImagem da frente do documento (multipart/form-data).
arquivo_versoarquivoNãoImagem do verso (multipart/form-data).
arquivo_base64stringNãoFrente em base64. Alternativa ao multipart.
arquivo_verso_base64stringNãoVerso em base64.
modelo_idinteiroNãoForça um modelo de IA específico. Padrão: o modelo de visão configurado.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/cliente_documento_ler.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -F "arquivo=@rg_frente.jpg" \
  -F "arquivo_verso=@rg_verso.jpg"

Resposta

{
  "ok": true,
  "data": {
    "normalizado": {
      "nome": "Mariana Gonçalves de Araujo",
      "cpfcgc": "529.982.247-25",
      "rgie": "4782913",
      "dt_nascimento": "1990-04-08",
      "sexo": "F",
      "pai": "Carlos Roberto de Araujo",
      "mae": "Tereza Goncalves de Araujo",
      "naturalidade": "Camboriu - SC"
    },
    "tipo_documento": "RG",
    "confianca": { "nome": "alta", "cpf": "alta", "rg": "media" },
    "avisos": [],
    "lados_lidos": 2,
    "modelo": "gpt-5.6-luna",
    "custo_usd": 0.00096,
    "duracao_ms": 7180
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoChamado com GET. Use POST.
400arquivo_ausenteNem "arquivo" (multipart) nem "arquivo_base64" foram enviados.
400formato_invalidoFormato fora de JPG, PNG, WEBP e PDF.
400base64_invalidoO base64 não pôde ser decodificado (ou ficou pequeno demais para ser imagem).
400imagem_invalidaO arquivo foi recebido mas não pôde ser preparado para leitura (corrompido, PDF sem página).
413arquivo_grandeArquivo acima de 20 MB.
422leitura_ilegivelA IA respondeu, mas o documento não pôde ser interpretado. Envie uma foto mais nítida e sem cortes.
502falha_leituraA chamada ao provedor de IA falhou (a mensagem traz o motivo).
503sem_modelo_visaoNenhum modelo de IA com leitura de imagem está ativo.
POST /api/v1/cliente_pre_cadastrar.php 🔑 requer chave · clientes:cadastrar ▶ Enviar cadastro de cliente (pré-cadastro)

Recebe um cadastro de cliente, padroniza todos os campos (nome em Title Case, CPF/CNPJ validado por dígito verificador, telefone e CEP com máscara, endereço no formato do Vigo), resolve a base e o grupo Vigo conforme o dia do mês, monta os planos expandindo os serviços inclusos do pacote, e enfileira como PRÉ-CADASTRO.

IMPORTANTE: este endpoint NÃO cria o cliente no Vigo — a criação acontece depois, quando um operador confere e efetiva o pré-cadastro. Envie simular=1 para validar sem enfileirar: a resposta mostra exatamente o que seria gravado, com erros e avisos.

Idempotência: informe idempotency_key; sem ela, reenviar o mesmo documento no mesmo dia devolve o pré-cadastro já existente em vez de duplicar. Os campos podem vir na raiz ou dentro de "dados"; o plano em "plano" ou como id_plano_vigo + opcionais.

RESPOSTA DA SIMULAÇÃO (simular=1): HTTP 200 com "ok": true MESMO QUANDO O CADASTRO É INVÁLIDO — quem diz se ele passaria é o campo "valido" (true/false), acompanhado de "erros" e "avisos" (cada item {campo, codigo, mensagem}).

A simulação traz ainda "dados" (as 65 colunas exatamente como seriam gravadas no Vigo, inclusive login e senha da central do assinante, que nascem iguais ao CPF), "destino", "planos" e "duplicidade" {tem, bloqueia, mensagem}.

ENVIO

REAL: HTTP 201 quando cria, 200 quando devolve um pré-cadastro já recebido (reaproveitado=true); dados inválidos dão HTTP 422 com codigo dados_invalidos e as listas "erros" e "avisos" dentro de "erro".

O "resumo" (nas duas respostas) traz, além de nome/documento/tipo/endereco/celular/vencimento/base/grupo/idempresa/planos_qtd/total_mensal/velocidade: "instalacao" — a taxa de instalação ou ativação calculada pelos planos: {titulo ("Taxa de instalação" ou "Taxa de ativação"), conhecida (false = a tabela de preços não cobre este plano e o valor fica para o operador), valor (à vista, null se isento ou desconhecido), rotulo ("ISENTO", "R$ 150,00" ou ""), valor_prazo e rotulo_prazo (no cartão), valor_cobrado e a_prazo (o que será cobrado com a forma de pagamento informada), cobra (true = há taxa a pagar e forma_pagamento passa a ser exigida), acesso e itens (composição, quando há mais de uma taxa)}; e "segundo_ponto" — a cortesia de um segundo ponto Wi-Fi: {plano_tem (o pacote dá direito), tem (o cliente recebe: plano_tem e sem restrição no SPC), spc_visto (havia consulta SPC válida para decidir), restricao (a consulta achou restrição)}.

Parâmetros

NomeTipoObrigatórioDescrição
nomestringSimNome completo (PF) ou razão social (PJ). Gravado SEM ACENTO; razão social de CNPJ vai em CAIXA ALTA.
nome_socialstringNãoNome pelo qual a pessoa é chamada. O Vigo não tem coluna para ele: é gravado no campo "obs", no começo, no formato "Nome social - Telefone internacional - Observação".
cpfcgcstringSimCPF ou CNPJ, com ou sem máscara. Define o tipo de pessoa.
cepstringSimCEP do endereço de instalação.
enderecostringSimRua, número e complemento juntos, como o Vigo grava: "Rua San Marino 1030 Bl B Apto 401". O número é obrigatório — sem número, escreva "sn". Alternativa: enviar logradouro + numero separados.
logradourostringNãoSó a rua/avenida. Use com "numero"; o sistema junta os dois. Alternativa a "endereco".
numerostringNãoNúmero do imóvel, quando enviado separado de "logradouro". OBRIGATÓRIO sempre que "logradouro" for enviado — sem número, envie "sn". (Não vale contar com o número dentro de complemento/apartamento: o campo é conferido à parte.)
complementostringNãoComplemento (ex.: "Sala 2", "Casa B", "Bloco A"), quando enviado separado.
apartamentostringNãoApartamento, quando enviado separado. Só o número já basta — vira "Apto 401" na concatenação. Preenchido sem predio_id, o tipo de instalação na anotação vira "APARTAMENTO - PREDIO NOVO".
predio_idinteiroNãoID do prédio de fibra (predios_fibra) quando a instalação é num edifício já cadastrado. Não muda o endereço: serve para o TIPO DE INSTALAÇÃO da anotação do cliente, que sai do tipo cadastrado do prédio (ONU APTO, CABO DE REDE, TIPO CASA) — é o que diz ao técnico o que levar. Use endereco_resolver para descobrir o id.
bairrostringSimBairro.
cidadestringSimCidade.
ufstringSimUF com 2 letras.
referenciastringSimPonto de referência para a instalação.
celularstringSimTelefone principal do cliente (coluna `celular` do Vigo, "Telefone (2)") — é por ele que saem WhatsApp, cobrança e agendamento. Aceita celular (DDD + 9 dígitos começando em 9) OU fixo (DDD + 8 dígitos); fixo entra com um AVISO de que provavelmente não recebe WhatsApp, não com erro. Deixa de ser obrigatório quando tel_internacional=1. Telefones da própria operadora (lista em cad_cliente_telefones_bloqueados, hoje 33650107) são recusados em qualquer campo de telefone: com o nosso número no cadastro, cobrança e agendamento voltam para nós e o cliente nunca é avisado.
telefonestringNãoTelefone fixo / recado (coluna `telefone` do Vigo, "Telefone (1)"). Aceita celular ou fixo, como o principal. Em branco, é gravado zerado ("00000000000").
tel_internacionalinteiroNão1 = o cliente tem número de fora do Brasil. As colunas de telefone e celular do Vigo vão ZERADAS ("00000000000") — não cabe um número internacional no formato delas — e o número real é gravado no campo "obs". Consequência: as automações por WhatsApp não alcançam esse cliente.
tel_intl_ddistringNãoCódigo do país do telefone internacional, só dígitos (ex.: 351 para Portugal, 1 para EUA). Consulte a lista aceita em cadPaisesDdi(). OBRIGATÓRIO quando tel_internacional=1.
tel_intl_numerostringNãoNúmero do assinante, sem o código do país. Mínimo 4 dígitos; país + número não passam de 15 (limite do padrão E.164). Gravado como "+351 912345678".
emailstringSimE-mail do cliente. RECUSADO quando contém "imbranet": e-mail da operadora faria o boleto e os avisos irem para uma caixa interna e o cliente ficaria sem receber, com o envio marcado como bem-sucedido. Cliente sem e-mail: envie sem_email=1.
sem_emailinteiroNão1 = o cliente não tem e-mail. A coluna do Vigo é obrigatória, então é gravada a sentinela sememail@imbranet.com.br — uma só, para dar para contar depois quantos clientes estão sem esse canal.
vencimentointeiroNãoDia de vencimento (10, 15 ou 20). Padrão: 10.
forma_pagamentostringSim, quando há taxa de instalaçãoForma de pagamento da taxa de instalação/ativação: Dinheiro, Cartão, Pix, Boleto ou Isento. Só é exigida quando o plano tem taxa (resumo.instalacao.cobra = true) — sem ela o envio é recusado com forma_pagamento_ausente. Pix e Dinheiro usam o preço à vista; Cartão e Boleto, o preço a prazo quando ele existe na tabela (resumo.instalacao.valor_cobrado e a_prazo mostram o que vai ser cobrado).
cfopstringNãoCFOP da nota (pessoa física E jurídica): 5301–5307 (dentro do estado) ou 6301–6307 (interestadual), serviço de comunicação. Sem valor, é deduzido: o final é 07 (usuário final) para pessoa física e para empresa ISENTA de Inscrição Estadual, e 03 (estabelecimento comercial) para empresa com IE; o prefixo vira 6 quando o cliente é de outro estado E a assinatura é apenas CHIP MÓVEL. Informado, é respeitado.
sexostringSim, em pessoa físicaM ou F. Obrigatório em pessoa física (erro sexo_ausente); ignorado em pessoa jurídica.
rgiestringSim (ou rg_do_cpf / ie_isento)RG (PF) ou Inscrição Estadual (PJ). OBRIGATÓRIO nos dois casos: em pessoa física, sem RG envie rg_do_cpf=1; em pessoa jurídica, sem IE envie ie_isento=1.
rg_do_cpfinteiroNãoPessoa física cujo documento não traz RG (CNH nova, passaporte): 1 grava o CPF em dígitos no campo rgie, sem pontuação. É o que a operação já faz à mão — melhor um número verificável do que o campo vazio. Ignorado em pessoa jurídica.
ie_isentointeiroNãoPessoa jurídica sem Inscrição Estadual: 1 grava "ISENTO" no campo rgie, que é o que a nota fiscal espera. Enviar a palavra "ISENTO" em rgie tem o mesmo efeito.
dt_nascimentostringSimPessoa física: data de nascimento. Pessoa jurídica: data de ABERTURA da empresa. Formato AAAA-MM-DD ou DD/MM/AAAA. Obrigatória nos dois casos (erro data_ausente); data que não existe ou no futuro dá data_invalida.
paistringNãoNome do pai (só pessoa física).
maestringSim, em pessoa físicaNome da mãe. Obrigatório em pessoa física (erro mae_ausente): é o dado que mais identifica uma pessoa quando o nome se repete. Em pessoa jurídica este campo não é usado — o Vigo grava ali o representante legal.
representante_nomestringSim, em pessoa jurídicaPessoa jurídica: quem responde pela empresa. OBRIGATÓRIO quando o documento é CNPJ.
representante_cpfstringSim, em pessoa jurídicaPessoa jurídica: CPF do representante legal, validado por dígito verificador. OBRIGATÓRIO quando o documento é CNPJ. Nome e CPF são gravados juntos no campo "mãe" do Vigo, no formato "Nome CPF: 000.000.000-00", porque o Vigo não tem campo próprio de representante.
representante_telefonestringNãoPessoa jurídica: telefone do representante legal. É para este número que vai o link de assinatura do contrato — sem ele, o link precisa ser entregue à mão.
representante_emailstringNãoPessoa jurídica: e-mail do representante legal, para onde vai o contrato já assinado. Validado; e-mail do domínio da própria IMBRANET é recusado.
representantesarrayNãoPessoa jurídica com mais de quem assina (sócios, procurador): lista de objetos {nome, cpf, telefone, email}. Substitui representante_nome/representante_cpf/representante_telefone/representante_email quando enviada. Nome e CPF vão para o campo "mãe" do Vigo separados por " | " — ex.: "Raphael Gasperi CPF: 061.496.329-03 | Ana Zuchi CPF: 124.658.179-57"; a coluna tem 250 caracteres e o que passar disso é cortado com aviso. Telefone e e-mail não cabem naquele campo: ficam em cliente_representantes, que é a fonte do contrato, e na anotação do cliente.
naturalidadestringSim, em pessoa físicaCidade - UF de nascimento (ex.: "Itajai - SC"). Obrigatória em pessoa física (erro naturalidade_ausente).
latitudenúmeroNãoLatitude da instalação (use endereco_resolver para obtê-la).
longitudenúmeroNãoLongitude da instalação.
dici_atendimentostringNãoURBANO ou RURAL. Padrão: URBANO.
vendedorstringNãoVendedor: o NOME do funcionário, sem o id (ex.: "RAPHAEL GASPERI"). Sem este campo, o vendedor é resolvido na efetivação a partir do operador que conferiu o pré-cadastro (operador → funcionário → CPF → cadastro_funcionarios da base). ATENÇÃO: o id do funcionário é por base — o mesmo funcionário tem números diferentes na Vigo 01 e na Vigo 02.
id_plano_vigointeiroSimID Vigo do pacote principal (veja cadastro_contexto). Pacote do tipo CHIP MÓVEL, sem opcionais fora desse tipo, muda três coisas: a banda do DICI é gravada como 1000, o CFOP pode virar interestadual e, em pessoa física, o cadastro vai para a base de planos móveis configurada em Conf. Cadastro Vigo em vez do rodízio por dia do mês.
opcionaisarrayNãoIDs Vigo dos opcionais escolhidos. O ID REPETIDO é a quantidade daquele opcional: [244, 244] são dois chips de dados 5GB, e cada um leva junto a sua cobrança de serviços de terceiros. Mandar o ID uma vez só continua valendo 1 unidade, como sempre.
simularinteiroNão1 = valida e devolve o resultado sem enfileirar.
idempotency_keystringNãoChave para não duplicar em caso de reenvio.
permitir_recadastrointeiroNão1 = confirma o cadastro mesmo havendo cadastro DESATIVADO (situação X) no mesmo documento. Sem esta confirmação o envio é RECUSADO com HTTP 422 (codigo dados_invalidos), trazendo em "erros" o item cliente_desativado no campo cpfcgc: a política da operação é reativar o cadastro desativado em vez de abrir outro, e isso vale inclusive quando existe um cadastro ativo junto. Com a confirmação, o envio passa e volta o aviso recadastro_confirmado.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/cliente_pre_cadastrar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "nome": "FULANO DE TAL",
  "cpfcgc": "123.456.789-09",
  "sexo": "M",
  "dt_nascimento": "1990-05-20",
  "rgie": "1234567",
  "mae": "MARIA DE TAL",
  "naturalidade": "Itajai - SC",
  "cep": "88300-000",
  "endereco": "Rua Exemplo 100 Apto 201",
  "bairro": "Centro",
  "cidade": "Itajai",
  "uf": "SC",
  "referencia": "Em frente a praca",
  "celular": "(47) 99999-0000",
  "email": "fulano@exemplo.com",
  "id_plano_vigo": 123,
  "forma_pagamento": "Pix",
  "idempotency_key": "pedido-0001",
  "simular": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "status": "pendente",
    "pre_cadastro_id": 116,
    "reaproveitado": false,
    "idempotency_key": "meu-sistema-000123",
    "mensagem": "Pré-cadastro criado. Aguarda conferência de um operador para ser efetivado no Vigo.",
    "resumo": {
      "nome": "Joao da Silva",
      "documento": "529.982.247-25",
      "tipo": "Pessoa Física",
      "endereco": "Rua Brusque 100 - Municipios, BALNEÁRIO CAMBORIÚ/SC",
      "celular": "(47) 99999-8888",
      "vencimento": "15",
      "base": "Vigo 02",
      "grupo": "GRUPO 27",
      "idempresa": 2,
      "planos_qtd": 5,
      "total_mensal": "219.80",
      "velocidade": "1000",
      "instalacao": {
        "acesso": "ponto",
        "valor": null,
        "conhecida": true,
        "rotulo": "ISENTO",
        "valor_prazo": null,
        "rotulo_prazo": "",
        "valor_cobrado": null,
        "a_prazo": false,
        "cobra": false,
        "itens": [],
        "titulo": "Taxa de instalação"
      },
      "segundo_ponto": {
        "plano_tem": true,
        "tem": true,
        "spc_visto": false,
        "restricao": false
      }
    },
    "destino": {
      "ok": true,
      "dia": 18,
      "base_id": 2,
      "base": "Vigo 02",
      "origem": "faixa",
      "grupo": "GRUPO 27",
      "idempresa": 2,
      "erro": null
    },
    "planos": {
      "linhas": [
        {
          "id_plano_vigo": 227,
          "descricao": "2024 - INTERNET DE ATÉ 1 GBPS DE DOWNLOAD NO PACOTE FIBRA 1000",
          "nome": "PACOTE FIBRA 1000",
          "valor": "136.90",
          "aliquota": "S",
          "usar": "S",
          "quantidade": 1,
          "total": "136.90",
          "papel": "pacote"
        },
        {
          "id_plano_vigo": 263,
          "descricao": "2024 - IBTV PLAY",
          "nome": "2024 - IBTV PLAY",
          "valor": "19.00",
          "aliquota": "S",
          "usar": "S",
          "quantidade": 1,
          "total": "19.00",
          "papel": "incluido"
        },
        {
          "id_plano_vigo": 43,
          "descricao": "ALUGUEL DE ROUTER",
          "nome": "ALUGUEL DE ROUTER",
          "valor": "29.90",
          "aliquota": "S",
          "usar": "S",
          "quantidade": 1,
          "total": "29.90",
          "papel": "opcional"
        }
      ],
      "total_mensal": "219.80"
    },
    "avisos": []
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoChamado com GET. Use POST.
422dados_invalidosEnvio real com algum problema abaixo. A lista vem em erro.erros (e os avisos em erro.avisos), cada item {campo, codigo, mensagem}. Na simulação os mesmos códigos vêm em data.erros, com HTTP 200 e valido=false.
422nome_ausentecampo nome — nome vazio.
422documento_invalidocampo cpfcgc — CPF/CNPJ com tamanho errado ou dígito verificador inválido.
422documento_inexistentecampo cpfcgc — o documento não existe na Receita.
422cnpj_situacaocampo cpfcgc — CNPJ com situação diferente de ATIVA na Receita (baixada, suspensa, inapta).
422cliente_desativadocampo cpfcgc — já existe cadastro DESATIVADO (situação X) neste documento. Reenvie com permitir_recadastro=1 para confirmar.
422duplicidade_indisponivelcampo cpfcgc — não foi possível conferir se o cliente já existe (base Vigo fora do ar). Tente de novo.
422sexo_ausentecampo sexo — pessoa física sem M ou F.
422data_ausentecampo dt_nascimento — data vazia (nascimento em PF, abertura em PJ).
422data_invalidacampo dt_nascimento — data que não existe ou fora de formato.
422mae_ausentecampo mae — pessoa física sem o nome da mãe.
422naturalidade_ausentecampo naturalidade — pessoa física sem naturalidade.
422rg_ausentecampo rgie — pessoa física sem RG. Sem RG no documento, envie rg_do_cpf=1.
422ie_ausentecampo rgie — pessoa jurídica sem Inscrição Estadual. Isenta, envie ie_isento=1.
422representante_ausentecampo representante_nome — CNPJ sem representante legal.
422representante_cpf_ausentecampo representante_cpf — representante sem CPF.
422representante_cpf_invalidocampo representante_cpf — CPF do representante com dígito inválido.
422cep_ausentecampo cep — CEP vazio.
422cep_invalidocampo cep (ou cob_cep) — CEP fora do formato de 8 dígitos.
422endereco_ausentecampo endereco — endereço vazio.
422endereco_sem_numerocampo endereco — rua sem número. Sem número, escreva "sn".
422numero_ausentecampo numero — logradouro enviado separado, sem "numero". Sem número, envie "sn".
422bairro_ausentecampo bairro — bairro vazio.
422cidade_ausentecampo cidade — cidade vazia.
422uf_invalidacampo uf — UF vazia ou que não existe.
422referencia_ausentecampo referencia — ponto de referência vazio.
422celular_ausentecampo celular — telefone principal vazio.
422celular_invalidocampo celular — número fora do formato (DDD + 8 ou 9 dígitos).
422celular_internacional_invalidocampo celular — telefone internacional sem DDI aceito ou com número curto/longo demais.
422telefone_invalidocampo telefone — número fora do formato.
422telefone_internacional_invalidocampo telefone — telefone internacional inválido.
422email_ausentecampo email — e-mail vazio. Cliente sem e-mail: envie sem_email=1.
422email_invalidocampo email — e-mail fora do formato, ou do domínio da IMBRANET.
422cfop_invalidocampo cfop — CFOP fora da faixa de serviço de comunicação (5301–5307 / 6301–6307).
422plano_ausentecampo plano — nenhum id_plano_vigo enviado.
422plano_inexistentecampo plano — o id_plano_vigo não existe no catálogo (veja cadastro_contexto).
422plano_e_opcionalcampo plano — o id enviado como pacote principal é um opcional.
422plano_inexistente_na_basecampo plano — o plano existe no catálogo mas não na base Vigo de destino.
422plano_divergente_na_basecampo plano — a descrição do plano na base de destino não bate com o catálogo do SysIMB.
422valor_divergentecampo plano — o valor do plano na base de destino não bate com o catálogo do SysIMB.
422vigo_indisponivelcampo plano — não foi possível conferir os planos na base Vigo (fora do ar). Tente de novo.
422opcional_inexistentecampo opcionais — um dos ids de opcional não existe no catálogo.
422regra_5gcampo opcionais — pacote FIBRA + 5G MÓVEL sem um PACOTE DADOS MÓVEL entre os opcionais.
422forma_pagamento_ausentecampo forma_pagamento — o plano tem taxa de instalação e a forma de pagamento não veio.
422documento_ausentecampo documentos — falta anexar documento exigido (pessoa jurídica: documento do representante e contrato social/ata, exceto MEI).

Avisos (não impedem)

CódigoO que indica
celular_fixoO telefone principal é fixo — provavelmente não recebe WhatsApp.
coordenada_ausenteCadastro sem latitude/longitude — o operador vai localizar no mapa.
nome_incompletoNome de pessoa física sem sobrenome.
sem_emailCliente sem e-mail (sem_email=1): gravada a sentinela sememail@imbranet.com.br.
cadastro_adicionalO documento já tem cadastro ATIVO — este será um cadastro adicional.
recadastro_confirmadoHavia cadastro desativado e o envio foi aceito porque veio permitir_recadastro=1.
tipo_ajustadoO tipo de pessoa foi corrigido pelo documento (11 dígitos = F, 14 = J).
velocidade_ausenteNão foi possível deduzir a velocidade (DICI) pelo pacote — o operador preenche.
obs_truncadaA observação passou de 250 caracteres e foi cortada.
cnpj_situacao_liberadaCNPJ fora de ATIVA na Receita, mas liberado manualmente por um operador.
celular_intl_parece_brTelefone principal marcado como internacional, mas com cara de número brasileiro.
telefone_intl_parece_brTelefone fixo marcado como internacional, mas com cara de número brasileiro.
nome_social_pjNome social num cadastro de pessoa jurídica — confira se não era nome fantasia.
representantes_truncadosA lista de representantes passou de 250 caracteres e foi cortada no campo do Vigo.
GET /api/v1/cliente_pre_consultar.php 🔑 requer chave · clientes:cadastrar ▶ Consultar situação do pré-cadastro

Informa em que pé está um cadastro enviado antes: se ainda aguarda conferência ou se foi efetivado (e com qual ID de cliente no Vigo). Cadastro descartado na conferência deixa de existir e a consulta devolve 404. Informe o id devolvido no envio ou a mesma idempotency_key usada. Cada chave de API só enxerga os pré-cadastros que ela própria enviou.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroNãoID do pré-cadastro (pre_cadastro_id).
idempotency_keystringNãoAlternativa ao id: a chave usada no envio.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/cliente_pre_consultar.php?id=456" \
  -H "Authorization: Bearer SUA_CHAVE"

Resposta

{
  "ok": true,
  "data": {
    "pre_cadastro_id": 12,
    "status": "efetivado",
    "situacao": "Cliente criado no Vigo.",
    "id_cliente_vigo": 215696,
    "base": { "base_id": 2, "grupo": "GRUPO 28", "idempresa": 2 },
    "nome": "Mariana Gonçalves de Araujo",
    "documento": "52998224725",
    "motivo": null,
    "criado_em": "2026-08-04 08:20:11",
    "efetivado_em": "2026-08-04 09:05:33"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_ausenteNem "id" nem "idempotency_key" foram enviados.
403sem_acessoO pré-cadastro foi enviado por outra chave de API — cada chave só enxerga os seus.
404nao_encontradoNão existe, ou foi DESCARTADO na conferência (o descarte apaga o pré-cadastro).

📁 App do Técnico — Atendimentos

POST /api/v1/tecnico_login.php 🔑 requer chave · atendimentos:ler ▶ Login do técnico

O técnico entra no app com o USUÁRIO E A SENHA DO SYSIMB (os mesmos da tela de login).

Devolve o token do técnico — enviado nas próximas chamadas no header X-Tecnico-Token, junto da chave da aplicação no Authorization —, quem ele é, o id dele em cada base do Vigo (o mesmo técnico tem um id em cada base) e o que as permissões dele deixam fazer ("pode"), para o app esconder o que daria 403 — "pode.atualizar" vale também para anexar (a assinatura inclusive). O token vale 15 dias, só junto da chave que fez o login.

Senhas erradas bloqueiam SÓ aquele usuário (10 seguidas em 15 minutos; um login certo zera a contagem) — não o IP: um servidor pode fazer o login de toda a equipe sem que o erro de um trave os outros. Só

POST: a senha não pode ir na URL. Guarde o token com segurança no aparelho — ele não aparece de novo.

Parâmetros

NomeTipoObrigatórioDescrição
loginstringSimLogin do operador no SysIMB.
senhastringSimSenha do SysIMB.
dispositivostringNãoTexto livre para identificar o aparelho (ex.: modelo do celular) — aparece na auditoria.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/tecnico_login.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "login": "fulano.tecnico",
  "senha": "SENHA_DO_TECNICO",
  "dispositivo": "Celular do Fulano"
}'

Resposta

{
  "ok": true,
  "data": {
    "token": "tk_0123456789abcdef0123456789abcdef0123456789abcdef",
    "expira_em": "2026-10-16T08:00:00",
    "operador": {
      "id": 42,
      "login": "fulano.tecnico",
      "nome": "Fulano Técnico",
      "setor": "Técnico de Fibra",
      "email": null
    },
    "bases": [
      {
        "base": 1,
        "base_nome": "Vigo 01",
        "id_funcionario": 101
      },
      {
        "base": 2,
        "base_nome": "Vigo 02",
        "id_funcionario": 104
      }
    ],
    "pode": {
      "abrir": true,
      "atualizar": true,
      "encerrar": true
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
400parametro_ausenteFaltou login ou senha.
401login_invalidoUsuário ou senha incorretos (a mesma resposta para os dois casos).
429login_bloqueadoMuitas senhas erradas para ESTE usuário (os outros seguem entrando); o header Retry-After diz em quantos segundos tentar de novo.
GET /api/v1/tecnico_sessao.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Conferir o login do técnico

Confere se o token do técnico ainda vale e devolve o mesmo perfil do login (sem token novo). Chame ao abrir o app: 401 = mandar para a tela de login.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/tecnico_sessao.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "expira_em": "2026-10-16T08:00:00",
    "operador": {
      "id": 42,
      "login": "fulano.tecnico",
      "nome": "Fulano Técnico",
      "setor": "Técnico de Fibra",
      "email": null
    },
    "bases": [
      {
        "base": 1,
        "base_nome": "Vigo 01",
        "id_funcionario": 101
      },
      {
        "base": 2,
        "base_nome": "Vigo 02",
        "id_funcionario": 104
      }
    ],
    "pode": {
      "abrir": true,
      "atualizar": true,
      "encerrar": true
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
POST /api/v1/tecnico_logout.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Sair (encerrar o login do técnico)

Encerra o login: o token deixa de valer na hora. Chame no "Sair" do app — senão o token vale até expirar.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/tecnico_logout.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "encerrado": true
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
GET /api/v1/atendimento_opcoes.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Opções dos formulários (tipos, setores, responsáveis)

Tipos e setores de atendimento e os funcionários que podem ser responsáveis, POR BASE — os ids são de cada base do Vigo, então use sempre os da base do atendimento. Funcionários: só quem está no quadro do SysIMB (ativo, férias ou afastado); o Vigo guarda todo mundo que já passou pela empresa. Base indisponível vem com "disponivel": false e sem as listas.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroNão1 = Vigo 01, 2 = Vigo 02. Sem ela, vêm todas.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_opcoes.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "bases": [
      {
        "base": 1,
        "base_nome": "Vigo 01",
        "disponivel": true,
        "tipos": [
          {
            "id": 1,
            "descricao": "INTERNET COM QUEDAS"
          },
          {
            "id": 2,
            "descricao": "SEM INTERNET"
          }
        ],
        "setores": [
          {
            "id": 5,
            "descricao": "SUPORTE PRESENCIAL"
          },
          {
            "id": 13,
            "descricao": "INSTALAÇÃO FIBRA"
          }
        ],
        "funcionarios": [
          {
            "id": 101,
            "nome": "Fulano Técnico"
          },
          {
            "id": 102,
            "nome": "Beltrano Técnico"
          }
        ]
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
GET /api/v1/atendimentos_listar.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Listar atendimentos

Sem parâmetro nenhum: os atendimentos ABERTOS em que o técnico logado é o responsável, das duas bases juntas, na ordem do agendamento — a lista do dia. O histórico não vem na lista (é o que pesa): peça com_historico=1 ou consulte o atendimento.

"meta.por_base" diz quantos vieram de cada base; "meta.truncado" = true quando o limite cortou a lista e "meta.proxima_pagina" diz qual página pedir (paginar exige base).

Abertura, agendamento e encerramento trazem "data_hora" completo com fuso (null se faltar a hora), além de data e hora separadas; agendamento e encerramento vêm null quando vazios. "cliente.latitude/longitude" vêm do cadastro do cliente (null se não houver) — servem para o mapa. "tem_anexo" é calculado na hora, a partir dos anexos que existem. Com cliente, setor_id, tipo_id ou responsável por id, "base" é obrigatória (esses ids são de cada base). Para listar encerrados de todos os responsáveis é preciso cliente ou um período.

Parâmetros

NomeTipoObrigatórioDescrição
responsavelstringNãoeu | todos | id do funcionário no Vigo (exige base). Padrão: eu — ou todos, quando vem cliente.
situacaostringNãoabertos (padrão) | encerrados | todos.
baseinteiroSim, com cliente, setor_id, tipo_id ou responsável por id1 = Vigo 01, 2 = Vigo 02. Sem ela, as duas.
clienteinteiroNãoId do cliente no Vigo.
setor_idinteiroNãoSetor de atendimento (ver atendimento_opcoes).
tipo_idinteiroNãoTipo de atendimento (ver atendimento_opcoes).
abertura_destringNãoAberto a partir de (AAAA-MM-DD).
abertura_atestringNãoAberto até (AAAA-MM-DD).
agendamento_destringNãoAgendado a partir de (AAAA-MM-DD).
agendamento_atestringNãoAgendado até (AAAA-MM-DD).
com_historicointeiroNão1 = inclui historico, historico_cliente e informacoes_internas em cada item.
limiteinteiroNãoItens por página e por base (padrão 100, até 500).
paginainteiroNão1 (padrão), 2, … — da página 2 em diante exige base.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimentos_listar.php?situacao=abertos" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": [
    {
      "base": 1,
      "base_nome": "Vigo 01",
      "id": 240001,
      "numero_os": "02100123450001",
      "situacao": "aberto",
      "descricao": "Sem sinal",
      "tipo": {
        "id": 2,
        "descricao": "SEM INTERNET"
      },
      "setor": {
        "id": 5,
        "descricao": "SUPORTE PRESENCIAL"
      },
      "responsavel": {
        "id": 101,
        "nome": "Fulano Técnico"
      },
      "cliente": {
        "id": 12345,
        "nome": "Cliente Exemplo",
        "endereco": "Rua das Flores 100 AP 201",
        "bairro": "Centro",
        "cidade": "Cidade Exemplo",
        "uf": "SC",
        "cep": "88000-000",
        "telefone": "(47) 3000-0000",
        "celular": "(47) 99000-0000",
        "email": "cliente@exemplo.com.br",
        "latitude": -27.0001,
        "longitude": -48.6001
      },
      "abertura": {
        "data_hora": "2026-10-01T08:10:00-03:00",
        "data": "2026-10-01",
        "hora": "08:10",
        "por": "fulano.tecnico"
      },
      "agendamento": {
        "data_hora": "2026-10-02T08:00:00-03:00",
        "data": "2026-10-02",
        "hora": "08:00"
      },
      "encerramento": null,
      "valor": 0.0,
      "tem_anexo": false
    },
    {
      "base": 2,
      "base_nome": "Vigo 02",
      "id": 210001,
      "numero_os": "02100123450002",
      "situacao": "aberto",
      "descricao": "Lentidão",
      "tipo": {
        "id": 2,
        "descricao": "SEM INTERNET"
      },
      "setor": {
        "id": 5,
        "descricao": "SUPORTE PRESENCIAL"
      },
      "responsavel": {
        "id": 104,
        "nome": "Fulano Técnico"
      },
      "cliente": {
        "id": 12345,
        "nome": "Cliente Exemplo",
        "endereco": "Rua das Flores 100 AP 201",
        "bairro": "Centro",
        "cidade": "Cidade Exemplo",
        "uf": "SC",
        "cep": "88000-000",
        "telefone": "(47) 3000-0000",
        "celular": "(47) 99000-0000",
        "email": "cliente@exemplo.com.br",
        "latitude": -27.0001,
        "longitude": -48.6001
      },
      "abertura": {
        "data_hora": "2026-10-01T08:10:00-03:00",
        "data": "2026-10-01",
        "hora": "08:10",
        "por": "fulano.tecnico"
      },
      "agendamento": {
        "data_hora": "2026-10-02T13:30:00-03:00",
        "data": "2026-10-02",
        "hora": "13:30"
      },
      "encerramento": null,
      "valor": 0.0,
      "tem_anexo": false
    }
  ],
  "meta": {
    "total": 2,
    "por_base": [
      {
        "base": 1,
        "total": 1
      },
      {
        "base": 2,
        "total": 1
      }
    ],
    "limite": 100,
    "pagina": 1,
    "truncado": false,
    "proxima_pagina": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_invalidosituacao, responsavel ou data fora do formato.
400base_obrigatoriaFiltro por cliente/setor/tipo/responsável por id, ou página 2 em diante, sem "base".
400filtro_amploEncerrados de todos os responsáveis sem cliente nem período.
GET /api/v1/atendimento_consultar.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Consultar um atendimento

Traz também "vinculados" (equipamentos, vendas, boletos e agenda DESTE atendimento, com valor e situação; os demais boletos do cliente não saem aqui) e "pendencias_fechamento" (o que responder em vinculos ao encerrar; lista vazia com o atendimento encerrado, null se a leitura falhar; com duas formas, "recebido" lista o que confirmar — [{"forma": "dinheiro", "valor": 50.0}] —, "pix_valor" é o valor do código PIX a gerar e "parcelas_base" o valor que vai no boleto).

O atendimento completo — por id (com base) ou pelo numero_os, que dispensa a base: o número que circula no chat é procurado nas duas. "historico" é o texto inteiro, para o técnico.

"historico_cliente" é o mesmo texto SEM as informações internas — é ele que pode ser mostrado ao cliente (na assinatura, por exemplo); o app não precisa tirar nada. "informacoes_internas" traz só as anotações internas, uma por item.

"anexos" lista os arquivos sem o conteúdo — baixe por atendimento_anexo_baixar: os antigos do Vigo e os da pasta do atendimento no storage (id 1000000000 ou mais, incluindo as fotos que o app grava direto lá), cada arquivo uma vez só. O responsável vem pelo id (o nome é o do cadastro de funcionários do Vigo).

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim, com id1 = Vigo 01, 2 = Vigo 02. Com numero_os é opcional.
idinteiroSim, ou numero_osId do atendimento.
numero_osstringNãoAlternativa ao id; sem base, procura nas duas.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_consultar.php?base=1&id=12345" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "base": 1,
    "base_nome": "Vigo 01",
    "id": 240001,
    "numero_os": "02100123450001",
    "situacao": "aberto",
    "descricao": "Sem sinal",
    "tipo": {
      "id": 2,
      "descricao": "SEM INTERNET"
    },
    "setor": {
      "id": 5,
      "descricao": "SUPORTE PRESENCIAL"
    },
    "responsavel": {
      "id": 101,
      "nome": "Fulano Técnico"
    },
    "cliente": {
      "id": 12345,
      "nome": "Cliente Exemplo",
      "endereco": "Rua das Flores 100 AP 201",
      "bairro": "Centro",
      "cidade": "Cidade Exemplo",
      "uf": "SC",
      "cep": "88000-000",
      "telefone": "(47) 3000-0000",
      "celular": "(47) 99000-0000",
      "email": "cliente@exemplo.com.br",
      "latitude": -27.0001,
      "longitude": -48.6001
    },
    "abertura": {
      "data_hora": "2026-10-01T08:10:00-03:00",
      "data": "2026-10-01",
      "hora": "08:10",
      "por": "fulano.tecnico"
    },
    "agendamento": {
      "data_hora": "2026-10-02T13:30:00-03:00",
      "data": "2026-10-02",
      "hora": "13:30"
    },
    "encerramento": null,
    "valor": 0.0,
    "tem_anexo": true,
    "historico": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n<Interna>\nPortão azul, tocar o interfone 2\n</Interna>\n\n--- Atualização: 02/10/2026 10:05 por Fulano Técnico ---\nA caminho do cliente\nAgendamento: 02/10/2026 - Tarde (a partir das 13:30) (reagendado)",
    "historico_cliente": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n--- Atualização: 02/10/2026 10:05 por Fulano Técnico ---\nA caminho do cliente\nAgendamento: 02/10/2026 - Tarde (a partir das 13:30) (reagendado)",
    "informacoes_internas": [
      "Portão azul, tocar o interfone 2"
    ],
    "anotacao_tecnica": "",
    "anexos": [
      {
        "id": 30001,
        "descricao": "Foto da caixa",
        "extensao": "jpeg",
        "tipo": "JPEG",
        "bytes": 482133
      }
    ],
    "vinculados": {
      "total": 1,
      "grupos": [
        {
          "chave": "equipamentos",
          "grupo": "Equipamentos",
          "icone": "📦",
          "itens": [
            {
              "id": 5001,
              "titulo": "Roteador X · MAC AA:BB:CC:00:00:01",
              "detalhe": "Venda · PIX — R$ 180,00",
              "situacao": "",
              "cor": "alerta",
              "valor": 180.0,
              "data": "2026-11-04 10:00:00",
              "link": null,
              "externo": false
            }
          ]
        }
      ],
      "erros": []
    },
    "pendencias_fechamento": [
      {
        "chave": "cg_5001",
        "titulo": "Roteador X · MAC AA:BB:CC:00:00:01",
        "acao": "finalizar",
        "forma": "pix",
        "valor": 180.0,
        "pagamentos": [
          {
            "forma": "pix",
            "valor": 180.0,
            "parcelas": 1
          }
        ],
        "pede": [],
        "recebido": [],
        "pix_gerar": true,
        "pix_valor": 180.0,
        "pix_celular": "(47) 99000-0000",
        "pix": null,
        "bloqueio": null,
        "troca": null
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteNem id nem numero_os.
404atendimento_nao_encontradoNão existe (nesta base, ou em nenhuma, na busca por numero_os).
409numero_os_ambiguoO numero_os existe nas duas bases — "data" lista os dois; repita com base.
POST /api/v1/atendimento_abrir.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Abrir atendimento

Abre o atendimento no Vigo com as mesmas regras da ficha do cliente no SysIMB: o histórico começa com a linha de agendamento — manha e tarde viram a hora em que a empresa abre de manhã e volta do almoço; hora usa a agendamento_hora. "Aberto por" é o técnico logado. Sem responsavel_id, o responsável é o próprio técnico.

A mesma descrição no mesmo cliente nos últimos 2 minutos é recusada como duplicada (409, com o id do que já existe em "data") — o app pode reenviar sem medo.

Com criar_evento=1, cria o evento na agenda Google do responsável (ou do setor, ou de quem abriu); falha no evento não desfaz o atendimento e vem em "evento.erro". Resposta 201 com o atendimento criado.

TEXTO: acentos e pontuação comum (travessão, aspas curvas, reticências, •, €) são gravados como vieram, e as quebras de linha são preservadas; o banco do Vigo não guarda emoji nem símbolos fora do Latin-1 — setas e marcas viram texto ("→" vira "->", "✅" vira "[ok]") e o resto é removido, assim como caracteres de controle invisíveis (menos tab e quebra de linha), sem falhar a gravação. Quando algo foi trocado ou removido, a resposta traz texto_ajustado = true.

🔐 Requer a permissão consultas_abrir_os no SysIMB (a permissão do app, app_tecnico_usar, NÃO abre OS).

Parâmetros

NomeTipoObrigatórioDescrição
sem_custobooleanoNãoAtendimento sem custo (1.12.1379): materiais e serviços da OS não são cobrados (equipamento vendido continua). Padrão 0. Exige a permissão atendimentos_gerenciar_custos (sem ela, 403 tecnico_sem_permissao). A resposta traz sem_custo e servico_tipo — o serviço configurado para o tipo de atendimento em Conf. Tipos de Atendimentos já entra na OS ao abrir (por hora, com 1 h até informar o horário).
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
clienteinteiroSimId do cliente no Vigo (nesta base).
descricaostringSimDescrição resumida.
tipo_idinteiroSimTipo de atendimento (ver atendimento_opcoes).
setor_idinteiroNãoSetor de atendimento (padrão 1).
responsavel_idinteiroNãoResponsável, id do Vigo nesta base. Ausente = o próprio técnico (só o responsável registra pelo app); 0 = sem responsável.
textostringNãoTexto do atendimento.
info_internastringNãoAnotação que o cliente não vê — fica no histórico dentro do bloco interno.
agendamento_datastringNãoAAAA-MM-DD (padrão: hoje).
agendamento_periodostringNãomanha (padrão) | tarde | hora.
agendamento_horastringSim, com agendamento_periodo = horaHH:MM.
criar_eventointeiroNão1 = cria o evento na agenda Google.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_abrir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "cliente": 54321,
  "tipo_id": 3,
  "descricao": "Sem internet",
  "texto": "Cliente relata que a internet caiu hoje cedo.",
  "agendamento_periodo": "tarde"
}'

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "base": 1,
      "base_nome": "Vigo 01",
      "id": 240001,
      "numero_os": "02100123450001",
      "situacao": "aberto",
      "descricao": "Sem sinal",
      "tipo": {
        "id": 2,
        "descricao": "SEM INTERNET"
      },
      "setor": {
        "id": 5,
        "descricao": "SUPORTE PRESENCIAL"
      },
      "responsavel": {
        "id": 101,
        "nome": "Fulano Técnico"
      },
      "cliente": {
        "id": 12345,
        "nome": "Cliente Exemplo",
        "endereco": "Rua das Flores 100 AP 201",
        "bairro": "Centro",
        "cidade": "Cidade Exemplo",
        "uf": "SC",
        "cep": "88000-000",
        "telefone": "(47) 3000-0000",
        "celular": "(47) 99000-0000",
        "email": "cliente@exemplo.com.br",
        "latitude": -27.0001,
        "longitude": -48.6001
      },
      "abertura": {
        "data_hora": "2026-10-01T08:10:00-03:00",
        "data": "2026-10-01",
        "hora": "08:10",
        "por": "fulano.tecnico"
      },
      "agendamento": {
        "data_hora": "2026-10-02T10:30:00-03:00",
        "data": "2026-10-02",
        "hora": "10:30"
      },
      "encerramento": null,
      "valor": 0.0,
      "tem_anexo": false,
      "historico": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n<Interna>\nPortão azul, tocar o interfone 2\n</Interna>",
      "historico_cliente": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem",
      "informacoes_internas": [
        "Portão azul, tocar o interfone 2"
      ],
      "anotacao_tecnica": ""
    },
    "texto_ajustado": false,
    "evento": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
403tecnico_sem_permissaoO usuário do técnico no SysIMB não tem a permissão consultas_abrir_os (abrir atendimento). O login informa em "pode".
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou cliente.
400tipo_invalidotipo_id ausente ou inexistente nesta base.
400setor_invalidosetor_id inexistente nesta base.
400responsavel_invalidoresponsavel_id não é funcionário desta base.
400parametro_invalidoDescrição vazia, data/período fora do formato ou hora marcada ausente.
404cliente_nao_encontradoO cliente não existe nesta base.
409duplicadoMesmo cliente e descrição nos últimos 2 minutos — "data.id" é o atendimento que já existe.
500erro_vigoO Vigo recusou a gravação.
POST /api/v1/atendimento_atualizar.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Atualizar atendimento

Acrescenta ao histórico o bloco "--- Atualização: data hora por <técnico> ---" com o texto e, se vier, a informação interna.

Opcionalmente reagenda (nova data/hora no Vigo) e troca tipo, descrição ou responsável — cada mudança é anotada pelo sistema no mesmo bloco, como informação interna (o cliente não vê): "Troca de técnico: X para Y", "Agendamento: … (reagendado)". Com alguma dessas mudanças, texto e info_interna são opcionais. Parâmetro que não vier = mantém (responsavel_id = 0 tira o responsável).

Se o mesmo bloco já for o fim do histórico (o app reenviou), nada é gravado e a resposta é 200 com ja_registrado = true.

BLOCO

CONTÍNUO: com continuar = 1 o texto entra no fim do último bloco, separado por uma linha em branco, em vez de abrir outro cabeçalho — para a visita do técnico (início, bobina, equipamento, fotos, teste) ficar num bloco só.

Vale quando o último bloco do histórico é "Atualização" do mesmo técnico, do mesmo dia, e nada foi gravado depois dele por outra pessoa ou caminho; senão abre bloco novo, como sem o parâmetro. Reagendamento ou troca de tipo/descrição/responsável sempre abrem bloco novo.

A resposta traz continuou = true (entrou no bloco existente) ou false (abriu outro); o reenvio do mesmo texto continua dando ja_registrado = true. Os endpoints de equipamento e PIX aceitam o mesmo continuar para a linha que gravam no histórico.

Só atendimento aberto e só o RESPONSÁVEL por ele (quem abriu não importa) — os outros recebem 403 nao_responsavel, nunca uma gravação descartada em silêncio.

TEXTO: acentos e pontuação comum (travessão, aspas curvas, reticências, •, €) são gravados como vieram, e as quebras de linha são preservadas; o banco do Vigo não guarda emoji nem símbolos fora do Latin-1 — setas e marcas viram texto ("→" vira "->", "✅" vira "[ok]") e o resto é removido, assim como caracteres de controle invisíveis (menos tab e quebra de linha), sem falhar a gravação. Quando algo foi trocado ou removido, a resposta traz texto_ajustado = true. O evento da agenda acompanha, quando houver.

🔐 Requer a permissão app_tecnico_usar (só do app — não libera nada nas telas) ou consultas_editar_os.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
textostringSim, ou info_interna, se nada mais mudarTexto da atualização.
info_internastringSim, ou texto, se nada mais mudarAnotação que o cliente não vê.
reagendar_datastringNãoNova data (AAAA-MM-DD).
reagendar_periodostringNãomanha (padrão) | tarde | hora.
reagendar_horastringSim, com reagendar_periodo = horaHH:MM.
tipo_idinteiroNãoNovo tipo.
descricaostringNãoNova descrição resumida (não pode ser vazia).
responsavel_idinteiroNãoNovo responsável (id do Vigo nesta base); 0 = tirar o responsável.
criar_eventobooleanoNãoAtendimento SEM evento na agenda: true cria um agora, na data/período de reagendar_* (obrigatórios neste caso), na agenda do responsável → do setor de atendimento → de quem está logado. Com evento já vinculado, é ignorado. Resposta: evento.criado = true.
copiar_agenda_idinteiroNãoCom criar_evento: cria também uma cópia do evento nesta agenda (id em google_calendar_agendas), sem vínculo.
continuarbooleanoNão1 = acrescenta ao FIM do último bloco, com uma linha em branco antes, sem abrir cabeçalho novo — quando o último bloco é "Atualização" deste técnico, de hoje, e nada foi gravado depois por outro caminho (NOC, tela, Vigo, encerramento). Senão, abre bloco novo como sempre. Com reagendamento ou troca de tipo/descrição/responsável, sempre bloco novo. Padrão 0. A resposta diz em "continuou" o que aconteceu.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_atualizar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "texto": "Cliente nao estava em casa, retorno amanha."
}'

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "base": 1,
      "base_nome": "Vigo 01",
      "id": 240001,
      "numero_os": "02100123450001",
      "situacao": "aberto",
      "descricao": "Sem sinal",
      "tipo": {
        "id": 2,
        "descricao": "SEM INTERNET"
      },
      "setor": {
        "id": 5,
        "descricao": "SUPORTE PRESENCIAL"
      },
      "responsavel": {
        "id": 101,
        "nome": "Fulano Técnico"
      },
      "cliente": {
        "id": 12345,
        "nome": "Cliente Exemplo",
        "endereco": "Rua das Flores 100 AP 201",
        "bairro": "Centro",
        "cidade": "Cidade Exemplo",
        "uf": "SC",
        "cep": "88000-000",
        "telefone": "(47) 3000-0000",
        "celular": "(47) 99000-0000",
        "email": "cliente@exemplo.com.br",
        "latitude": -27.0001,
        "longitude": -48.6001
      },
      "abertura": {
        "data_hora": "2026-10-01T08:10:00-03:00",
        "data": "2026-10-01",
        "hora": "08:10",
        "por": "fulano.tecnico"
      },
      "agendamento": {
        "data_hora": "2026-10-02T13:30:00-03:00",
        "data": "2026-10-02",
        "hora": "13:30"
      },
      "encerramento": null,
      "valor": 0.0,
      "tem_anexo": false,
      "historico": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n<Interna>\nPortão azul, tocar o interfone 2\n</Interna>\n\n--- Atualização: 02/10/2026 10:05 por Fulano Técnico ---\nA caminho do cliente\nAgendamento: 02/10/2026 - Tarde (a partir das 13:30) (reagendado)",
      "historico_cliente": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n--- Atualização: 02/10/2026 10:05 por Fulano Técnico ---\nA caminho do cliente\nAgendamento: 02/10/2026 - Tarde (a partir das 13:30) (reagendado)",
      "informacoes_internas": [
        "Portão azul, tocar o interfone 2"
      ],
      "anotacao_tecnica": ""
    },
    "ja_registrado": false,
    "continuou": false,
    "texto_ajustado": false,
    "reagendado": "02/10/2026 - Tarde (a partir das 13:30)",
    "evento": {
      "ok": true,
      "agenda": "Fulano Técnico",
      "erro": null
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
403tecnico_sem_permissaoO usuário do técnico no SysIMB não tem a permissão do app (app_tecnico_usar) nem a da tela (consultas_editar_os) para atualizar atendimento. O login informa em "pode".
403nao_responsavelO técnico não é o responsável pelo atendimento (ou ele está sem responsável). Nada é gravado; "data.responsavel" diz de quem é. Quem abriu não importa.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou id.
400parametro_invalidoSem texto nem info_interna e sem nenhuma mudança, data/hora fora do formato ou descrição vazia.
400tipo_invalidotipo_id inexistente nesta base.
400responsavel_invalidoresponsavel_id não é funcionário desta base.
404atendimento_nao_encontradoNão existe nesta base.
409atendimento_encerradoO atendimento já está encerrado.
500erro_vigoO Vigo recusou a gravação.
POST /api/v1/atendimento_encerrar.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Encerrar atendimento

Encerra com as regras da ficha do cliente: grava data, hora e "fechado por" (o técnico logado) e o bloco "--- Fechamento ---" com o texto.

Com subiu_poste=1, o texto padrão de análise preliminar de risco entra no histórico, logo antes do fechamento (em atendimento antigo, abaixo do bloco INFORMACOES UTEIS) — e uma vez só, mesmo que já tenha sido colado no texto. O evento da agenda vai para a agenda de finalizados e o lançamento do painel Em Andamento é concluído. Encerrar de novo dá 409 (não reescreve a data).

TEXTO: acentos e pontuação comum (travessão, aspas curvas, reticências, •, €) são gravados como vieram, e as quebras de linha são preservadas; o banco do Vigo não guarda emoji nem símbolos fora do Latin-1 — setas e marcas viram texto ("→" vira "->", "✅" vira "[ok]") e o resto é removido, assim como caracteres de controle invisíveis (menos tab e quebra de linha), sem falhar a gravação. Quando algo foi trocado ou removido, a resposta traz texto_ajustado = true.

VINCULADOS: equipamento que saiu do estoque para este atendimento e ainda aguarda entrega é finalizado junto (vai para o estoque do cliente no Vigo — menos o Uso no Atendimento, uso_com_cobranca/uso_sem_cobranca, que fica só na OS — e, se for venda ou uso_com_cobranca, para Vendas Pendentes); o que foi feito volta em "vinculos" (lista de textos).

COBRANÇA DO ATENDIMENTO (1.12.1382): o custo (materiais com cobrança, cabos pelo metro lançado, serviços e excedente, menos isenções e desconto) vem como a pendência de chave "os", com as mesmas perguntas da venda na forma escolhida no Total do atendimento (PIX: pix_gerar/pix_recebido ou recebido do código em aberto; dinheiro: recebido; cartão: cartao_pago; boleto: parcelas) — sem forma escolhida vem com bloqueio, "escolher_forma": true e as opções em "formas" (forma, nome, parcelas_max): pergunte ao técnico e responda vinculos.os.forma (+ vinculos.os.parcelas no cartão/boleto) NO PRÓPRIO encerrar (1.12.1386; ou antes, por atendimento_cobranca_forma); a forma vale antes das outras respostas, então mande junto o que ela pede (ex.: dinheiro → recebido).

DUAS FORMAS (1.12.1403, só no pagamento unificado): vinculos.os.forma = "misto" + vinculos.os.pagamentos = [{forma, valor, parcelas}, {forma, parcelas}] (a 2ª fica com o resto); a pendência "os" traz então "pagamentos" com as duas partes e pede o de cada uma (recebido do PIX/dinheiro, cartao_pago, parcelas do boleto), igual à venda em duas formas.

Ver o valor antes: atendimento_total; o código PIX dela volta em pix_gerado (ou pix_gerado_atendimento, se a venda de equipamento também gerou).

EQUIPAMENTO VENDIDO JUNTO (1.12.1385): com venda de equipamento E custo no atendimento, a pendência "os" traz "junto" (pode, escolha true/false/null, custo, equipamento, total_junto, itens[]) — desde a 1.12.1403 o PADRÃO é junto (uma cobrança só, na forma do Total) e não se pergunta mais; para separar (o equipamento com a forma dele), responda vinculos.os.junto = false (ou antes, atendimento_cobranca_forma com junto false).

Junto, o item do equipamento vem com junto = true e sem perguntas de pagamento, e a pendência "os" cobra o valor dele também.

Falta de resposta (recebido, cartão pago, troca) devolve 409 vinculos_pendentes, com a lista em data.pendencias e data.problemas, e nada muda; responda em "vinculos" pela chave de cada pendência.

Cada pendência de equipamento traz "material" (1.12.1407): true = 🛠️ Uso no Atendimento (produto sem 🔗), que não é equipamento — é finalizado junto, não pede resposta e o valor já está na pendência "os"; a tela não o lista no fechamento.

Boleto na cobrança do atendimento: o histórico ganha o total e uma linha por parcela (número do boleto, valor e vencimento), como na venda de equipamento.

Venda em PIX sem código: com pix_recebido = true no item, o cliente já pagou e nada é gerado (o PIX fica dado como recebido, como o dinheiro); sem isso, o código é gerado ao encerrar e volta em pix_gerado (boleto_id, valor, vencimento, pix, url, enviado, envio_erro).

Com pix_enviar = true, o MESMO código vai ao cliente por WhatsApp; falha no envio não impede o encerramento, e dá para tentar de novo em atendimento_pix_enviar. Sem isso, o técnico avisa o cliente. Se o código não for gerado, o atendimento não encerra. Só o RESPONSÁVEL encerra.

🔐 Requer a permissão app_tecnico_usar (só do app — não libera nada nas telas) ou consultas_fechar_os.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
textostringNãoA solução (recomendado).
subiu_posteinteiroNão1 = registra a análise preliminar de risco (trabalho em altura).
vinculosobjetoNãoRespostas às pendencias_fechamento, pela chave de cada uma: {"cg_5001": {"recebido": true}, "cg_5002": {"parcelas": 3}, "cg_5003": {"cartao_pago": true}, "cg_5004": {"pix_enviar": true}, "cg_5006": {"pix_recebido": true}, "cg_5005": {"troca": {"estoque_cliente_id": 900, "destino": "estoque", "confirmado": true}}, "os": {"forma": "dinheiro", "recebido": true}}. "destino" da troca: estoque (com confirmado = true) ou teste (com "problema"). Na chave "os" (cobrança do atendimento): forma (pix | dinheiro | cartao_credito | boleto) e parcelas, além das respostas de pagamento e de junto.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_encerrar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "texto": "Conector trocado, sinal normalizado."
}'

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "base": 1,
      "base_nome": "Vigo 01",
      "id": 240001,
      "numero_os": "02100123450001",
      "situacao": "encerrado",
      "descricao": "Sem sinal",
      "tipo": {
        "id": 2,
        "descricao": "SEM INTERNET"
      },
      "setor": {
        "id": 5,
        "descricao": "SUPORTE PRESENCIAL"
      },
      "responsavel": {
        "id": 101,
        "nome": "Fulano Técnico"
      },
      "cliente": {
        "id": 12345,
        "nome": "Cliente Exemplo",
        "endereco": "Rua das Flores 100 AP 201",
        "bairro": "Centro",
        "cidade": "Cidade Exemplo",
        "uf": "SC",
        "cep": "88000-000",
        "telefone": "(47) 3000-0000",
        "celular": "(47) 99000-0000",
        "email": "cliente@exemplo.com.br",
        "latitude": -27.0001,
        "longitude": -48.6001
      },
      "abertura": {
        "data_hora": "2026-10-01T08:10:00-03:00",
        "data": "2026-10-01",
        "hora": "08:10",
        "por": "fulano.tecnico"
      },
      "agendamento": {
        "data_hora": "2026-10-02T13:30:00-03:00",
        "data": "2026-10-02",
        "hora": "13:30"
      },
      "encerramento": {
        "data_hora": "2026-10-02T14:40:00-03:00",
        "data": "2026-10-02",
        "hora": "14:40",
        "por": "fulano.tecnico"
      },
      "valor": 0.0,
      "tem_anexo": true,
      "historico": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n<Interna>\nPortão azul, tocar o interfone 2\n</Interna>\n\n--- Atualização: 02/10/2026 10:05 por Fulano Técnico ---\nA caminho do cliente\nAgendamento: 02/10/2026 - Tarde (a partir das 13:30) (reagendado)\n\nAntes do início deste atendimento, foi realizada uma análise preliminar de risco do local, verificadas as condições de segurança para execução da atividade. Utilizados os EPIs e equipamentos necessários, conforme os procedimentos internos e as normas de Segurança e Saúde no Trabalho.\n\n========================================\n\n--- Fechamento: 02/10/2026 14:40 por Fulano Técnico ---\nConector trocado, sinal normalizado",
      "historico_cliente": "Agendamento: 02/10/2026 - HORA MARCADA: 10:30\n\nCliente sem sinal desde ontem\n\n--- Atualização: 02/10/2026 10:05 por Fulano Técnico ---\nA caminho do cliente\nAgendamento: 02/10/2026 - Tarde (a partir das 13:30) (reagendado)\n\nAntes do início deste atendimento, foi realizada uma análise preliminar de risco do local, verificadas as condições de segurança para execução da atividade. Utilizados os EPIs e equipamentos necessários, conforme os procedimentos internos e as normas de Segurança e Saúde no Trabalho.\n\n========================================\n\n--- Fechamento: 02/10/2026 14:40 por Fulano Técnico ---\nConector trocado, sinal normalizado",
      "informacoes_internas": [
        "Portão azul, tocar o interfone 2"
      ],
      "anotacao_tecnica": ""
    },
    "andamento_concluido": false,
    "texto_ajustado": false,
    "evento": {
      "ok": true,
      "agenda": "Finalizados",
      "erro": null
    },
    "pix_gerado": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
403tecnico_sem_permissaoO usuário do técnico no SysIMB não tem a permissão do app (app_tecnico_usar) nem a da tela (consultas_fechar_os) para encerrar atendimento. O login informa em "pode".
403nao_responsavelO técnico não é o responsável pelo atendimento (ou ele está sem responsável). Nada é gravado; "data.responsavel" diz de quem é. Quem abriu não importa.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou id.
404atendimento_nao_encontradoNão existe nesta base.
409atendimento_encerradoO atendimento já está encerrado.
409vinculos_pendentesO atendimento tem algo vinculado que precisa de confirmação antes de fechar, e nada foi alterado: venda em dinheiro ou PIX (sem código PIX pago no Vigo) ou no cartão que ainda não foi confirmada como recebida. erro.mensagem diz qual item e o que falta. O app ainda não envia essas confirmações — por enquanto, esse fechamento é feito pela ficha do cliente no SysIMB.
500vinculos_falhaFalhou a finalização da entrega de um equipamento vinculado; o atendimento não foi fechado. erro.mensagem traz o motivo e o que já tinha sido finalizado.
500erro_vigoO Vigo recusou a gravação.
GET /api/v1/atendimento_equipamentos.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Equipamentos do atendimento

O bloco de equipamentos da OS: "itens" (o que está no atendimento, com tipo, valor, boletos e situação; venda.pagamentos traz as partes do pagamento — uma forma só = uma parte; duas formas = venda.forma "misto" e duas partes, cada uma com forma, valor e parcelas; em boletos[], PIX em aberto traz pix_copia_cola, o conteúdo do QR Code: o app desenha o QR com esse texto, sem alterar nada, para o cliente escanear; "valor" é a parte DESTE item, "cobranca_valor" é o valor do boleto inteiro e "junto" lista os outros itens da OS no mesmo código PIX (comodato_id, produto, valor), vazio quando o boleto é só deste item; "situacao" vem vazia em item inserido pelo técnico, e "status" = pendente até encerrar), "cliente" (o que ele já tem no Vigo), "retornados", "estoque_tecnico" (o que o técnico tem em mãos para inserir, com o id usado no inserir) e "pix_elegiveis" (vendas que podem entrar num código PIX; com duas formas, o valor é só o da parte em PIX).

"tipos" e "formas" trazem as opções; "tipos_servico" traz as do produto SEM 🔗 Vincular estoque do cliente: Uso no Atendimento (uso_com_cobranca — desde 1.12.1385 a única opção: o material entra sempre com o valor; itens antigos podem vir com tipo_chave uso_sem_cobranca) — cada item de "estoque_tecnico" e de "itens" diz qual vale em vincula_cliente (true = "tipos", false = "tipos_servico"; item assim não vai para o estoque do cliente no Vigo).

Em "itens", tipo_chave é a chave da opção (ex.: uso_com_cobranca, que é cobrado como venda e por isso traz "venda").

Venda com cobranca_junto = true (1.12.1399) vai na cobrança do atendimento (atendimento_total, escolha "junto"): a forma em "venda" não vale, e "pagamento" vem como "💳 junto na cobrança do atendimento".

QUANTIDADE: item sem MAC/série fica somado numa linha — "estoque_tecnico[].quantidade" diz quantas unidades o técnico tem, e "itens[].quantidade" quantas entraram na OS (o título já vem como "3x PRODUTO"). Campos de ícone são caminhos do SysIMB, a partir do mesmo endereço da API. Só o RESPONSÁVEL lê. Boletos: só os deste atendimento.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_equipamentos.php?base=1&id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "id": 240001,
      "numero_os": "02100123450001",
      "aberto": true,
      "cliente_id": 12345,
      "id_funcionario_vigo": 101
    },
    "tecnico": {
      "id": 30,
      "nome": "Fulano Técnico"
    },
    "aviso": null,
    "cliente_celular": "(47) 99000-0000",
    "itens": [
      {
        "id": 5001,
        "produto_id": 829,
        "titulo": "Roteador X · MAC AA:BB:CC:00:00:01",
        "tipo": "Venda",
        "tipo_chave": "venda",
        "venda": {
          "forma": "pix",
          "parcelas": 1,
          "valor": 180.0,
          "pagamentos": [
            {
              "forma": "pix",
              "valor": 180.0,
              "parcelas": 1
            }
          ]
        },
        "pagamento": "PIX — R$ 180,00",
        "boletos": [
          {
            "id": 1000001,
            "rotulo": "PIX",
            "valor": 180.0,
            "vencimento": "2026-11-11",
            "situacao": "em aberto",
            "pago": false,
            "pix": true,
            "pix_copia_cola": "00020126...6304ABCD",
            "enviado_em": null
          }
        ],
        "status": "pendente",
        "situacao": "",
        "e_troca": false,
        "troca": null,
        "pode_remover": true,
        "pode_alterar": true,
        "pode_troca": false
      }
    ],
    "cliente": [
      {
        "id": 900,
        "titulo": "ONU Y · SN ABC123",
        "modalidade": "Comodato",
        "produto_sysimb": "ONU Y"
      }
    ],
    "retornados": [],
    "estoque_tecnico": [
      {
        "id": 7001,
        "produto_id": 829,
        "titulo": "Roteador X · MAC AA:BB:CC:00:00:02",
        "valor_vista": 180.0,
        "valor_prazo": 200.0
      }
    ],
    "pix_elegiveis": [
      {
        "id": 5001,
        "titulo": "Roteador X · MAC AA:BB:CC:00:00:01",
        "forma": "pix",
        "valor": 180.0,
        "situacao": ""
      }
    ],
    "tipos": {
      "venda": "Venda"
    },
    "formas": {
      "pix": {
        "nome": "PIX",
        "parcelas_max": 1
      }
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
500erro_equipamentosFalha ao ler os equipamentos.
POST /api/v1/atendimento_equipamento_inserir.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Inserir equipamento no atendimento

Coloca na OS um item que o técnico tem em mãos. Ele só entra no estoque do cliente no Vigo ao encerrar (e nunca, se o produto não tem 🔗 Vincular estoque do cliente: aí o tipo é uso_com_cobranca ou uso_sem_cobranca — Uso no Atendimento).

Item somado (estoque_tecnico[].quantidade > 1, sem MAC/série) aceita "quantidade": entra só ela, o técnico fica com o resto; até lá dá para remover ou alterar. Grava uma linha no histórico.

EQUIPAMENTO × MATERIAL (1.12.1389): "vincula_cliente" de cada item de estoque_tecnico[] separa — true = equipamento (escolher o tipo em "tipos"; uma unidade por vez; vai para o estoque do cliente no Vigo ao encerrar), false = material (sem tipo — vale uso_com_cobranca — e com "quantidade"; fica só na OS).

VALOR: sempre o do cadastro do produto — o app nunca informa nem edita valor (venda_valor é ignorado); material sem valor entra com R$ 0, e produto sem valor não se vende pelo app (409).

A venda pode combinar duas formas (venda_pagamentos): o técnico diz quanto vai em uma, e o app completa a outra com o que falta para o total.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
estoque_funcionario_idinteiroSimestoque_tecnico[].id de atendimento_equipamentos.
quantidadeinteiroNãoPadrão 1. Até estoque_tecnico[].quantidade (item sem MAC/série somado numa linha). Mais de 1 só no Uso no Atendimento (vincula_cliente = false): o que vai para o estoque do cliente no Vigo entra uma unidade por vez (409). Em uso_com_cobranca o valor é o preço da unidade × quantidade.
tipostringNãoObrigatório para produto com vincula_cliente = true. Produto com vincula_cliente = true: contratacao_plano_wifi, negociacao_comodato, troca_garantia, troca_comodato, venda ou aluguel (chaves de "tipos"). Produto com vincula_cliente = false (sem 🔗 Vincular estoque do cliente no cadastro): uso_com_cobranca (Uso no Atendimento, a única chave de "tipos_servico" desde 1.12.1385 — pode omitir o tipo) — não vai para o estoque do cliente no Vigo, e entra SEMPRE com o valor: preço à vista do cadastro × quantidade (produto sem preço manda venda_valor), sem forma de pagamento, na COBRANÇA DO ATENDIMENTO, cobrada numa forma só ao encerrar. uso_sem_cobranca não é mais aceito: quem não cobra é o operador, isentando no Total do atendimento; o que um serviço lançado já inclui não é cobrado. Opção do outro grupo = 409 operacao_recusada.
venda_formastringNãoSó em venda: pix, dinheiro, cartao_credito ou boleto (chaves de "formas").
venda_parcelasinteiroNãoSó em venda no cartão (1 a 12) ou boleto (1 a 6). Em 1x vale o preço à vista; de 2x em diante, o a prazo.
venda_valorstringNãoIGNORADO desde a 1.12.1389: pelo app o valor é sempre o do cadastro do produto. Material sem valor no cadastro entra com R$ 0; venda de produto sem valor é recusada (409).
venda_pagamentoslistaNãoSó em venda com DUAS formas (pagamento combinado), no lugar de venda_forma/venda_parcelas: [{"forma": "pix", "valor": "80.00"}, {"forma": "cartao_credito", "valor": "120.00", "parcelas": 3}] (lista ou o JSON dela). Formas diferentes, cada uma com valor, e a soma igual ao total: o preço a prazo se uma delas é cartão/boleto em 2x ou mais; senão, o à vista. Soma diferente = 409 operacao_recusada com o total certo na mensagem. Com os pagamentos SEPARADOS no atendimento (atendimento_total → junto.escolha = false), duas formas são recusadas (409): cada cobrança numa forma só (1.12.1403).
trocaobjetoNãoSó em troca, e opcional: o equipamento que sai do cliente, como em atendimento_equipamento_troca_definir.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_equipamento_inserir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "estoque_funcionario_id": 678,
  "tipo": "negociacao_comodato"
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Inserido: Roteador X. Ele vai para o cliente quando o atendimento fechar.",
    "linha": "EQUIPAMENTO INSERIDO: Roteador X · MAC AA:BB:CC:00:00:01 - Motivo: Venda - PIX - R$ 180,00",
    "aviso": null,
    "id": 5001
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_equipamento_alterar.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Trocar tipo ou pagamento

Muda o tipo ou o pagamento de um item ainda pendente. Mudar a forma pega de novo o preço do cadastro; para manter o valor combinado, envie a mesma forma e o valor atual em venda_valor. Deixar de ser venda à vista, ou mudar o valor, exclui o código PIX em aberto (e o dos outros itens da mesma cobrança).

Com duas formas (venda_pagamentos), o código só cai se mudar o valor da parte que ele cobra (a parte em PIX; sem PIX, a em dinheiro). Código já pago trava a alteração.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idinteiroSimitens[].id de atendimento_equipamentos.
tipostringSimProduto com vincula_cliente = true: contratacao_plano_wifi, negociacao_comodato, troca_garantia, troca_comodato, venda ou aluguel (chaves de "tipos"). Produto com vincula_cliente = false (sem 🔗 Vincular estoque do cliente no cadastro): uso_com_cobranca (Uso no Atendimento, a única chave de "tipos_servico" desde 1.12.1385 — pode omitir o tipo) — não vai para o estoque do cliente no Vigo, e entra SEMPRE com o valor: preço à vista do cadastro × quantidade (produto sem preço manda venda_valor), sem forma de pagamento, na COBRANÇA DO ATENDIMENTO, cobrada numa forma só ao encerrar. uso_sem_cobranca não é mais aceito: quem não cobra é o operador, isentando no Total do atendimento; o que um serviço lançado já inclui não é cobrado. Opção do outro grupo = 409 operacao_recusada.
venda_formastringNãoSó em venda: pix, dinheiro, cartao_credito ou boleto (chaves de "formas").
venda_parcelasinteiroNãoSó em venda no cartão (1 a 12) ou boleto (1 a 6). Em 1x vale o preço à vista; de 2x em diante, o a prazo.
venda_valorstringNãoIGNORADO desde a 1.12.1389: pelo app o valor é sempre o do cadastro do produto. Material sem valor no cadastro entra com R$ 0; venda de produto sem valor é recusada (409).
venda_pagamentoslistaNãoSó em venda com DUAS formas (pagamento combinado), no lugar de venda_forma/venda_parcelas: [{"forma": "pix", "valor": "80.00"}, {"forma": "cartao_credito", "valor": "120.00", "parcelas": 3}] (lista ou o JSON dela). Formas diferentes, cada uma com valor, e a soma igual ao total: o preço a prazo se uma delas é cartão/boleto em 2x ou mais; senão, o à vista. Soma diferente = 409 operacao_recusada com o total certo na mensagem. Com os pagamentos SEPARADOS no atendimento (atendimento_total → junto.escolha = false), duas formas são recusadas (409): cada cobrança numa forma só (1.12.1403).
trocaobjetoNãoSó em troca, e opcional: o equipamento que sai do cliente, como em atendimento_equipamento_troca_definir.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_equipamento_alterar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "item_id": 55,
  "tipo": "negociacao_comodato"
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Tipo alterado.",
    "linha": "...",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_equipamento_remover.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Remover equipamento do atendimento

Tira o item da OS e devolve ao estoque do técnico. Pelo app não há devolução ao estoque da empresa. Código PIX em aberto do item é excluído no Vigo, inclusive o que cobria outros itens: "msg" avisa para gerar outro.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idinteiroSimitens[].id de atendimento_equipamentos.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_equipamento_remover.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 123,
  "item_id": 123
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Removido: Roteador X voltou para o estoque do técnico Fulano Técnico.",
    "linha": "...",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
GET /api/v1/atendimento_total.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Total do atendimento

O 💰 Total do atendimento (1.12.1386), o mesmo cálculo da tela: "linhas" = cada coisa cobrada (grupo equipamentos = equipamento vendido; materiais; cabos = metros × valor do metro lançado; servicos; excedente), com "valor_tabela" e "valor" (0 quando "isento" ou com "sem_custo").

"custo_cobrar" = o que a COBRANÇA DO ATENDIMENTO cobra (materiais + cabos + serviços + excedente, menos desconto e OS atrelada); "cobrar" = custo_cobrar + equipamento vendido JUNTO (junto.valor). O equipamento vendido separado tem a cobrança dele (atendimento_equipamentos).

"junto" (1.12.1399): pode = há venda para juntar ao custo; escolha = true (uma cobrança só — o PADRÃO desde a 1.12.1403) ou false (o técnico/escritório separou); itens = as vendas que podem ir junto, cada uma com titulo, valor e "pagamento" (a forma própria dela, usada se for separado); total_junto = o valor da cobrança única se escolher junto.

Como a tela (1.12.1403): mostrem a cobrança única (total_junto) com um botão "Separar pagamentos" (junto false); separado, cada venda com a forma dela e o custo com a sua, e um botão "Unificar pagamento" (junto true). Escolher: atendimento_cobranca_forma com "junto".

"cobranca.pagamentos" = as partes da forma escolhida (uma forma = uma parte; duas formas = forma "misto", só no unificado: a 1ª com o valor escolhido, a 2ª com o resto de agora); "cobranca.pagamentos_erro" = o custo mudou e a 1ª parte passou do total (escolher de novo).

"vendas_proprias" (1.12.1405) = vendas da OS que já têm cobrança própria (ex.: PIX gerado): ficam fora da unificada, cada uma à parte, numa forma só (id, titulo, valor, pagamento; o PIX dela vem no item de atendimento_equipamentos).

"cobranca" = a forma escolhida (null = ainda não escolhida: a OS não encerra sem ela), se já foi fechada, o código PIX em aberto (pix, com pix_copia_cola para o QR) e os boletos. "formas" = as opções para atendimento_cobranca_forma.

Isenção, desconto e OS atrelada são do escritório (permissão atendimentos_gerenciar_custos): o app só lê. Só o RESPONSÁVEL lê.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_total.php?base=1&id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "id": 240001,
      "numero_os": "02100123450001",
      "aberto": true
    },
    "sem_custo": false,
    "linhas": [
      {
        "grupo": "servicos",
        "titulo": "1 un. · Suporte / Sem internet",
        "detalhe": "R$ 100,00 / unidade",
        "valor_tabela": 100.0,
        "valor": 100.0,
        "isento": false
      },
      {
        "grupo": "cabos",
        "titulo": "Cabo DROP 120 m",
        "detalhe": "120 m × R$ 1,50 (Lançamento Cabo FLAT)",
        "valor_tabela": 180.0,
        "valor": 180.0,
        "isento": false
      }
    ],
    "totais": {
      "equipamentos": 0.0,
      "materiais": 0.0,
      "cabos": 180.0,
      "servicos": 100.0,
      "excedente": 0.0
    },
    "subtotal": 280.0,
    "desconto": 0.0,
    "credito_os_atrelada": 0.0,
    "total": 280.0,
    "custo": 280.0,
    "custo_cobrar": 280.0,
    "junto": {
      "pode": false,
      "escolha": null,
      "valor": 0.0,
      "itens": [],
      "total_junto": 0.0
    },
    "vendas_proprias": [],
    "cobrar": 280.0,
    "cobranca": {
      "forma": "pix",
      "parcelas": 1,
      "pagamentos": [
        {
          "forma": "pix",
          "valor": 280.0,
          "parcelas": 1
        }
      ],
      "pagamentos_erro": null,
      "fechada": false,
      "valor_cobrado": null,
      "pix": {
        "id": 1000001,
        "tipo": "pix",
        "parcela": 1,
        "parcelas": 1,
        "valor": 280.0,
        "vencimento": "2026-11-26",
        "situacao": "aberto",
        "pago": false,
        "url": "https://…",
        "pix_copia_cola": "00020126…6304ABCD",
        "beneficiario": "EMPRESA X - CNPJ: 00.000.000/0001-00",
        "enviado_em": null
      },
      "boletos": []
    },
    "formas": [
      {
        "forma": "pix",
        "nome": "PIX",
        "parcelas_max": 1
      },
      {
        "forma": "dinheiro",
        "nome": "Dinheiro",
        "parcelas_max": 1
      },
      {
        "forma": "cartao_credito",
        "nome": "Cartão",
        "parcelas_max": 12
      },
      {
        "forma": "boleto",
        "nome": "Boleto",
        "parcelas_max": 6
      }
    ],
    "cliente_celular": "(47) 99000-0000"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
500erro_totalFalha ao calcular o total.
POST /api/v1/atendimento_cobranca_forma.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Forma de pagamento do atendimento

Escolhe a forma de pagamento da COBRANÇA DO ATENDIMENTO (o custo de atendimento_total → custo_cobrar), a mesma escolha do 💰 Total da tela (1.12.1386). Sem ela a OS não encerra.

Com equipamento vendido na OS (atendimento_total → junto.pode), "junto" escolhe se ele vai na MESMA cobrança (true: uma cobrança só, na forma escolhida aqui) ou SEPARADO (false: o equipamento fica com a forma dele) — 1.12.1399; dá para mandar só "junto", só "forma", ou os dois (o junto é aplicado primeiro). Também dá para mandar no próprio atendimento_encerrar (vinculos.os.forma / vinculos.os.parcelas). Trocar de PIX para outra forma exclui no Vigo o código PIX em aberto (pago trava a troca). A resposta traz "total" com a cobrança atualizada.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
formastringNãopix, dinheiro, cartao_credito ou boleto (formas[] de atendimento_total), ou "misto" para DUAS formas (com "pagamentos"). Obrigatório se não vier "junto".
pagamentoslistaNãoSó com forma "misto" (1.12.1403): [{"forma": "pix", "valor": "200,00", "parcelas": 1}, {"forma": "boleto", "parcelas": 2}] — a 1ª com o valor (maior que zero e menor que o total), a 2ª fica com o resto. Formas diferentes. Só no pagamento UNIFICADO: separado, cada cobrança tem uma forma só (409).
parcelasinteiroNãoCartão 1 a 12, boleto 1 a 6 (padrão 1). PIX e dinheiro: 1.
juntobooleanoNãotrue = equipamento vendido e custo numa cobrança só (o padrão desde a 1.12.1403); false = separados (1.12.1399) — a cobrança em duas formas volta para "escolher a forma", e venda em duas formas não deixa separar (409). Só vale com junto.pode em atendimento_total (senão 409). Mudar exclui o código PIX em aberto da cobrança.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_cobranca_forma.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "junto": true,
  "forma": "boleto",
  "parcelas": 2
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Forma de pagamento do atendimento: PIX.",
    "linha": "…",
    "aviso": null,
    "total": {
      "forma": "boleto",
      "parcelas": 2,
      "fechada": false,
      "valor_cobrado": null,
      "pix": null,
      "boletos": [],
      "cobrar": 300.0,
      "junto": {
        "pode": true,
        "escolha": true,
        "valor": 180.0,
        "itens": [
          {
            "id": 5001,
            "titulo": "Roteador X · MAC AA:BB:CC:00:00:01",
            "valor": 180.0,
            "pagamento": "PIX — R$ 180,00"
          }
        ],
        "total_junto": 300.0
      }
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_cobranca_pix.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Código PIX da cobrança do atendimento

Gera — ou REFAZ, com o valor de agora — o código PIX da cobrança do atendimento (1.12.1386; o "Gerar código PIX" do 💰 Total). Exige a forma "pix" (atendimento_cobranca_forma). O código anterior ainda em aberto é excluído no Vigo; pago trava. Use também quando o encerrar disser que o custo mudou depois do código.

"pix" é o copia e cola (conteúdo do QR); para enviar ao cliente por WhatsApp, atendimento_pix_enviar com o "boleto_id". Escreve "Código PIX GERADO…" no histórico.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_cobranca_pix.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Código PIX gerado: R$ 280,00, vence 26/11/2026.",
    "linha": "…",
    "aviso": null,
    "boleto_id": "1000001",
    "valor": "280",
    "vencimento": "2026-11-26",
    "url": "https://…",
    "pix": "00020126…6304ABCD",
    "celular": "(47) 99000-0000",
    "beneficiario": "EMPRESA X - CNPJ: 00.000.000/0001-00"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
GET /api/v1/atendimento_servicos.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Serviços do atendimento

Os 🛠️ serviços da OS (1.12.1386), o mesmo bloco da tela. "itens" = os lançados: origem "tipo" = o custo do tipo de atendimento, que entra SOZINHO ao abrir (Conf. Tipos de Atendimentos); origem "manual" = lançado depois.

Por hora: "sem_horario" = true enquanto ninguém informou o horário (cobra só a 1ª hora) — informe com atendimento_servico_horario ("pode_horario"). "excedente" = o que a OS usou além do que o serviço inclui (ex.: inclui 300 m de cabo, usou 350 m).

"catalogo" = os serviços que dá para lançar (só com a OS aberta; o metro de cabo não entra: ele vem do cabo baixado com a OS). Valores em número; "total" = serviços + excedente (0 com "sem_custo"). Só o RESPONSÁVEL lê.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_servicos.php?base=1&id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "id": 240001,
      "numero_os": "02100123450001",
      "aberto": true
    },
    "sem_custo": false,
    "itens": [
      {
        "id": 37,
        "servico_id": 4,
        "servico": "Serviço Técnico",
        "variacao": null,
        "unidade": "hora",
        "quantidade": 1.0,
        "origem": "tipo",
        "titulo": "1 h · Serviço Técnico",
        "hora_inicio": null,
        "hora_fim": null,
        "minutos": null,
        "sem_horario": true,
        "valor_unitario": 100.0,
        "valor_total": 100.0,
        "excedente": [],
        "excedente_total": 0.0,
        "excedente_sem_valor": false,
        "status": "pendente",
        "pode_remover": true,
        "pode_horario": true
      }
    ],
    "catalogo": [
      {
        "id": 5,
        "servico": "Mudança de endereço - Até 300 metros",
        "valor": 150.0,
        "unidade": "unidade",
        "unidade_rotulo": "Unidade",
        "variacao": null,
        "observacao": null,
        "inclui": "300 m de CABO DROP X"
      }
    ],
    "total_servicos": 100.0,
    "total_excedente": 0.0,
    "total": 100.0
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
500erro_servicosFalha ao ler os serviços.
POST /api/v1/atendimento_servico_inserir.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Lançar serviço no atendimento

Lança na OS um serviço do "catalogo" de atendimento_servicos (1.12.1386). O valor é SEMPRE o da tabela de Valores de Serviços (ou o da variação, com variacao = 1) × quantidade: o app não manda valor. Por

HORA: hora_inicio e hora_fim (HH:MM, no mesmo dia) — 1ª hora cheia e 50% a cada meia hora (ou fração) depois dela (1h00 = 1 h; 1h10 = 1,5 h; 1h40 = 2 h). METRO e

UNIDADE: quantidade inteira. Escreve "SERVIÇO: …" no histórico. O custo do tipo já entra ao abrir: não lance de novo — por hora, informe o horário dele.

REENVIO: mande uma "referencia" única por lançamento; a mesma de novo devolve o anterior com "ja_registrado": true.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
servico_idinteiroSimcatalogo[].id de atendimento_servicos.
quantidadeinteiroNãoMetro ou unidade (inteiro, maior que zero). Por hora é ignorado: vale o horário.
hora_iniciostringNãoPor hora: início (HH:MM). Obrigatório no serviço por hora.
hora_fimstringNãoPor hora: fim (HH:MM, depois do início, no mesmo dia).
variacaobooleanoNão1 = usa o valor da variação do serviço (ex.: Rural). Serviço sem variação recusa.
referenciastringNãoChave única do lançamento (até 100 caracteres), para o reenvio não lançar duas vezes. Também aceita "idempotency_key".
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_servico_inserir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "servico_id": 4,
  "hora_inicio": "08:00",
  "hora_fim": "09:40",
  "referencia": "os-12345-servico-1",
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "ja_registrado": false,
    "msg": "Serviço lançado: 2 h · Serviço Técnico (08:00–09:40, 1h40) — R$ 200,00 (R$ 100,00/hora).",
    "linha": "SERVIÇO: 2 h · Serviço Técnico (08:00–09:40, 1h40) - R$ 200,00 (R$ 100,00/hora)",
    "aviso": null,
    "id": 38,
    "titulo": "2 h · Serviço Técnico (08:00–09:40, 1h40)",
    "valor": 200.0
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
400parametro_invalido"referencia" e "idempotency_key" vieram diferentes, ou referência com mais de 100 caracteres.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_servico_horario.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Horário do serviço por hora

Informa ou corrige o horário de um serviço COBRADO POR HORA já lançado e ainda pendente (1.12.1386) — típico do custo do tipo, que entra ao abrir cobrando só a 1ª hora. Recalcula: 1ª hora cheia e 50% a cada meia hora (ou fração) depois dela. Escreve "SERVIÇO (horário): …" no histórico.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idinteiroSimitens[].id de atendimento_servicos (com pode_horario = true).
hora_iniciostringSimInício (HH:MM).
hora_fimstringSimFim (HH:MM, depois do início, no mesmo dia).
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_servico_horario.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "item_id": 37,
  "hora_inicio": "08:00",
  "hora_fim": "09:10",
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Horário registrado: 1,5 h · Serviço Técnico (08:00–09:10, 1h10) — R$ 150,00.",
    "linha": "…",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_servico_remover.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Remover serviço do atendimento

Tira da OS um serviço ainda pendente, inclusive o custo do tipo (1.12.1386). Escreve "SERVIÇO

REMOVIDO: …" no histórico.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idinteiroSimitens[].id de atendimento_servicos (com pode_remover = true).
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_servico_remover.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "item_id": 38,
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Serviço removido: 1,5 h · Serviço Técnico (08:00–09:10, 1h10).",
    "linha": "…",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
GET /api/v1/atendimento_cabos.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Cabos do atendimento

Os 🧵 cabos usados na OS (1.12.1387).

"itens" = origem "drop": baixa de cabo DROP/caixa da bobina do técnico — inclusive a feita pelo app no estoque_bobina_baixar COM a OS (atendimento_base + atendimento_id; sem eles a baixa não aparece aqui); origem "as": cabo AS tirado de uma bobina do estoque da empresa, lançado pelo escritório. Estornados não entram.

"valor" = metros × valor do metro lançado da tabela (null se o cabo não é cobrado assim); o que um serviço inclui sai no atendimento_total. "pode_remover" = o app pode estornar (só DROP, com a OS aberta).

"bobinas" = as bobinas DROP/caixa que o técnico do atendimento tem com saldo, para baixar pelo estoque_bobina_baixar. Só o RESPONSÁVEL lê.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_cabos.php?base=1&id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "id": 240001,
      "numero_os": "02100123450001",
      "aberto": true
    },
    "itens": [
      {
        "id": 195,
        "produto_id": 591,
        "produto": "CABO DROP X 2KM",
        "valor": 7.5,
        "metros": 5,
        "origem": "drop",
        "titulo": "5 m CABO DROP X 2KM · BOBINA 02 (591-B2)",
        "icone": "/uploads/produtos/…",
        "detalhe": "Bobina do técnico Fulano Técnico · baixa pelo app",
        "data": "2026-11-19 10:20:00",
        "pode_remover": true
      }
    ],
    "metros": 5,
    "bobinas": [
      {
        "id": 36,
        "codigo": "591-B2",
        "produto_id": 591,
        "produto": "CABO DROP X 2KM",
        "numero": "BOBINA 02",
        "metragem": 1195
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
500erro_cabosFalha ao ler os cabos.
POST /api/v1/atendimento_cabo_remover.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Estornar cabo do atendimento

ESTORNO de um cabo DROP/caixa baixado na OS (1.12.1387): os metros voltam para a MESMA bobina do técnico (bobina zerada volta a ficar com ele) e a baixa fica marcada como estornada — não some do histórico da bobina. Para corrigir a metragem, estorne e baixe de novo (estoque_bobina_baixar com a OS e uma referencia nova). Cabo AS saiu do estoque da empresa: pelo app é recusado (409), o escritório remove pela tela. Escreve "CABO REMOVIDO do atendimento: …" no histórico.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idinteiroSimitens[].id de atendimento_cabos (com pode_remover = true).
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_cabo_remover.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "item_id": 195,
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Removido: 5 m CABO DROP X 2KM · BOBINA 02 (591-B2) voltou para a bobina do técnico Fulano Técnico.",
    "linha": "CABO REMOVIDO do atendimento: 5 m CABO DROP X 2KM · BOBINA 02 (591-B2) - voltou para a bobina do técnico Fulano Técnico",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou (cabo AS, já estornado, de outra OS, bobina já devolvida ao estoque): erro.mensagem diz o motivo.
GET /api/v1/atendimento_materiais.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Materiais do atendimento

O que foi usado na OS sem ir para o estoque do cliente, só pela quantidade, sem venda, comodato ou troca.

"itens" traz duas origens. origem "tecnico" = material de consumo (produto marcado como "Material de consumo") registrado do estoque do técnico: status "pendente" (reservado, sai do estoque dele quando a OS é encerrada; pode_remover = true) ou "baixado". origem "empresa" = item lançado pelo escritório na Saída de Estoque "Uso no Atendimento" (1.12.1367): já saiu do estoque da empresa, situacao "Usado na OS"; pode ser também um equipamento, e então "titulo" traz o MAC/SN. "detalhe" diz de onde saiu.

"estoque_tecnico" = material de consumo que o técnico tem em mãos como Reserva Funcionário, UM POR PRODUTO, com a quantidade somada — é o produto_id do registrar.

Desde a 1.12.1366 o material de consumo sai para o técnico como Uso para Trabalho e NÃO fica no estoque dele: essa lista traz só saldo antigo e tende a vir vazia. Material de consumo não aparece em atendimento_equipamentos. Só o RESPONSÁVEL lê. Ícones são caminhos do SysIMB, a partir do mesmo endereço da API.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_materiais.php?base=1&id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "atendimento": {
      "id": 240001,
      "numero_os": "02100123450001",
      "aberto": true
    },
    "tecnico": {
      "id": 30,
      "nome": "Fulano Técnico"
    },
    "aviso": null,
    "itens": [
      {
        "id": 15,
        "produto_id": 793,
        "produto": "CONECTOR X",
        "quantidade": 2,
        "titulo": "2x CONECTOR X",
        "funcionario": "Fulano Técnico",
        "status": "pendente",
        "origem": "tecnico",
        "detalhe": "Estoque de Fulano Técnico",
        "situacao": "Sai do estoque do técnico ao encerrar a OS",
        "data": "2026-11-17 14:10:00",
        "pode_remover": true
      }
    ],
    "estoque_tecnico": [
      {
        "produto_id": 793,
        "produto": "CONECTOR X",
        "quantidade": 8
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
500erro_materiaisFalha ao ler os materiais.
POST /api/v1/atendimento_material_inserir.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Registrar material usado

Registra na OS a quantidade usada de um material de consumo do estoque do técnico responsável (Reserva Funcionário). Desde a 1.12.1366 o material de consumo sai para o técnico como Uso para Trabalho e não fica no estoque dele: só há o que registrar enquanto houver saldo antigo em estoque_tecnico.

A quantidade fica reservada na OS (some do estoque_tecnico) e sai de vez do estoque dele quando a OS é encerrada; até lá dá para remover. O SysIMB escreve "MATERIAL

UTILIZADO: 2x …" no histórico — o app não manda texto próprio. Registrar o mesmo material de novo cria outra linha (não soma).

REENVIO: mande uma "referencia" única por registro; repetir a mesma referência na mesma OS devolve o registro anterior com "ja_registrado": true, sem reservar de novo.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
produto_idinteiroSimestoque_tecnico[].produto_id de atendimento_materiais.
quantidadeinteiroSimQuantidade usada, de 1 até o que o técnico tem em mãos.
referenciastringNãoChave única do registro (até 100 caracteres), para o reenvio não reservar duas vezes. Também aceita o nome "idempotency_key".
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_material_inserir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "produto_id": 793,
  "quantidade": 2,
  "referencia": "os-12345-conector-1",
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "ja_registrado": false,
    "id": 15,
    "msg": "Registrado: 2x CONECTOR X. Sai do estoque do técnico quando o atendimento for encerrado.",
    "linha": "MATERIAL UTILIZADO: 2x CONECTOR X\nEstoque do técnico Fulano Técnico",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
400parametro_invalido"referencia" e "idempotency_key" vieram com valores diferentes.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_material_remover.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Remover material do atendimento

Tira da OS um item ainda "pendente": a quantidade inteira volta ao estoque do técnico — o que ele registrou volta para ele, e o que veio da Saída de Estoque "Uso no Atendimento" (origem "empresa") também vai para o estoque dele (o responsável). Pelo app nada volta direto ao estoque da empresa: essa devolução é do escritório, pela tela. Para corrigir a quantidade, remova e registre de novo. Item já baixado (OS encerrada) não sai. O SysIMB escreve "MATERIAL

REMOVIDO: …" no histórico.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
material_idinteiroSimitens[].id de atendimento_materiais.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_material_remover.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "material_id": 15,
  "continuar": 1
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Removido: 2x CONECTOR X. Voltou ao estoque de Fulano Técnico.",
    "linha": "MATERIAL REMOVIDO: 2x CONECTOR X\nVoltou ao estoque do técnico Fulano Técnico",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
GET /api/v1/atendimento_equipamento_troca_opcoes.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Opções do equipamento da troca

O que pode ser o equipamento que sai do cliente numa troca: "cliente" (o estoque dele no Vigo; "pode" = false quando o produto não está vinculado) e "produtos" (catálogo, para o que não estava cadastrado). "regra" diz o que informar: serial, mac ou nenhum.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
produto_idinteiroSimO produto que entra no cliente.
item_idinteiroNãoAo editar a troca de um item já inserido.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_equipamento_troca_opcoes.php?base=1&id=123&produto_id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "cliente": [
      {
        "id": 900,
        "nome": "ONU Y",
        "serial": "ABC123",
        "mac": "",
        "modalidade": "Comodato",
        "icone": "/uploads/produtos/y.png",
        "pode": true,
        "regra": "serial"
      }
    ],
    "produtos": [
      {
        "id": 829,
        "nome": "Roteador X",
        "regra": "mac"
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
500erro_equipamentosFalha ao ler as opções.
POST /api/v1/atendimento_equipamento_troca_definir.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Definir o equipamento da troca

Define ou edita o equipamento que sai do cliente num item de Troca Garantia ou Troca Comodato. Sem isso o atendimento não encerra.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idinteiroSimitens[].id do item de troca.
trocaobjetoSim{"estoque_cliente_id": 900} para um equipamento do cliente, ou {"produto_id": 829, "mac": "...", "serial": "..."} para um que não estava cadastrado.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_equipamento_troca_definir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "item_id": 55,
  "troca": {
    "estoque_cliente_id": 900
  }
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Equipamento da troca salvo.",
    "linha": "...",
    "aviso": null
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
400parametro_invalido"troca" não veio como objeto.
POST /api/v1/atendimento_pix_gerar.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Gerar código PIX

Gera no Vigo UMA cobrança PIX com a soma das vendas escolhidas (vence em 7 dias, fora do dia da mensalidade) e devolve o copia e cola. Chamar de novo para um item que já tem código é recusado.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
item_idslistaSimLista de pix_elegiveis[].id de atendimento_equipamentos.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_pix_gerar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 12345,
  "item_ids": [
    55
  ]
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Código PIX gerado: R$ 180,00, vence 11/11/2026.",
    "linha": "...",
    "aviso": null,
    "boleto_id": 1000001,
    "valor": 180.0,
    "vencimento": "2026-11-11",
    "url": "https://exemplo/boleto.pdf",
    "pix": "00020126...6304ABCD",
    "celular": "(47) 99000-0000"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409atendimento_encerradoO atendimento já está encerrado.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_pix_enviar.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Enviar código PIX ao cliente

Envia por WhatsApp, ao celular do cadastro do cliente, o código PIX já gerado neste atendimento, e registra no histórico. Nunca gera outro. Vale com o atendimento encerrado. Cada chamada é um envio: confirme com o técnico antes e não repita sozinho em caso de erro de rede. Recusa boleto pago, excluído ou de outro atendimento, e cliente sem celular.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
boleto_idinteiroSimboleto_id devolvido por atendimento_pix_gerar, ou pix.boleto_id das pendências.
continuarbooleanoNão1 = a linha que o sistema escreve no histórico entra no fim do último bloco do técnico, sem cabeçalho novo — mesmas condições do atendimento_atualizar. Padrão 0 (bloco novo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_pix_enviar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 123,
  "boleto_id": 123
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Código PIX enviado para (47) 99000-0000.",
    "linha": "...",
    "aviso": null,
    "celular": "(47) 99000-0000",
    "enviado_em": "04/11/2026 15:30"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_usar nem consultas_atendimento_equipamentos.
403nao_responsavelO técnico não é o responsável pelo atendimento. "data.responsavel" diz de quem é.
400base_invalida"base" ausente ou diferente das bases do Vigo.
400parametro_ausenteFaltou "id" ou outro parâmetro obrigatório.
404atendimento_nao_encontradoAtendimento não encontrado nesta base.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
POST /api/v1/atendimento_anexo_enviar.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Anexar arquivo ao atendimento

Envia foto, vídeo, assinatura ou PDF numa chamada só, em multipart/form-data (não JSON), e devolve o id do anexo — se der erro, nada fica gravado pela metade. Foto (JPG, PNG) e PDF até 10 MB; vídeo (MP4, MOV, 3GP, WEBM) até 150 MB. O tipo é conferido pelo CONTEÚDO do arquivo, não pelo nome. Atendimento encerrado também recebe anexo — a assinatura pode chegar depois do fechamento.

A descrição segue a mesma regra de texto dos atendimentos (emoji é removido) e é cortada em 200 caracteres. Só o RESPONSÁVEL anexa. Resposta 201.

O arquivo vai para o storage de arquivos da empresa, na pasta do atendimento (a mesma em que o app grava direto), e o id devolvido é 1000000000 ou mais; se a pasta já tem o MESMO arquivo, ele é aproveitado e o id é o dele — mandar duas vezes não duplica.

Com o storage indisponível, ou vídeo acima de 100 MB, o arquivo vai para o banco do Vigo, como antes, e o id fica abaixo de 1000000000. O id é sempre inteiro.

🔐 Requer a permissão app_tecnico_usar (só do app — não libera nada nas telas) ou consultas_editar_os — a mesma do atualizar, então quem registra também consegue anexar a assinatura.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do atendimento.
arquivoarquivoSimO arquivo (campo de upload do multipart).
descricaostringNãoDescrição (até 200 caracteres; padrão: o nome do arquivo).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_anexo_enviar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -F "base=1" \
  -F "id=12345" \
  -F "arquivo=@foto.jpg" \
  -F "descricao=Foto da instalacao"

Resposta

{
  "ok": true,
  "data": {
    "anexo": {
      "id": 1000000042,
      "descricao": "Foto da caixa",
      "extensao": "jpeg",
      "tipo": "JPEG",
      "bytes": 482133
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
403tecnico_sem_permissaoO usuário do técnico no SysIMB não tem a permissão do app (app_tecnico_usar) nem a da tela (consultas_editar_os) para anexar arquivo. O login informa em "pode".
403nao_responsavelO técnico não é o responsável pelo atendimento (ou ele está sem responsável). Nada é gravado; "data.responsavel" diz de quem é. Quem abriu não importa.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou id.
400arquivo_ausenteNão veio o campo "arquivo".
400arquivo_invalidoO upload chegou incompleto.
404atendimento_nao_encontradoNão existe nesta base.
413arquivo_grandeFoto/PDF acima de 10 MB ou vídeo acima de 150 MB.
415tipo_nao_aceitoNão é JPG, PNG, PDF nem vídeo MP4/MOV/3GP/WEBM.
500erro_vigoO Vigo recusou a gravação.
GET /api/v1/atendimento_cliente.php 🔑 requer chave · atendimentos:ler 👷 token do técnico ▶ Cliente do atendimento (cadastro, planos e acessos)

O que o técnico precisa do cliente em campo, numa chamada só. "cliente": situação, cliente desde, login e senha da Central do Assinante, velocidade do cadastro e coordenadas — CPF, filiação e nascimento não vêm. "planos": os planos contratados ("ativo" = cobrado).

"acessos": cada login PPPoE com a senha, se está conectado agora, IP e MAC (da sessão atual, ou da última quando offline), a sessão, se está bloqueado, o plano no RADIUS e a BANDA DESTE LOGIN — a velocidade do cadastro é uma só por cliente; quem tem dois logins tem duas bandas. Plano de bloqueio vem com download/upload null. Se o RADIUS não responder, "acessos" vem null e "meta.aviso" explica. Substitui app_getcliente, app_getplanosid e app_getlogins do Vigo.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
clienteinteiroSimId do cliente no Vigo (nesta base).

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/atendimento_cliente.php?base=1&cliente=54321" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "cliente": {
      "base": 1,
      "id": 12345,
      "nome": "Cliente Exemplo",
      "situacao": "L",
      "situacao_label": "Liberado",
      "cliente_desde": "2023-05-10",
      "central_assinante": {
        "login": "cliente.exemplo",
        "senha": "senha-da-central"
      },
      "velocidade_cadastro_mbps": 500,
      "latitude": -27.0001,
      "longitude": -48.6001
    },
    "planos": [
      {
        "id": 90001,
        "descricao": "INTERNET 500 MEGA FIBRA",
        "valor": 99.9,
        "quantidade": 1,
        "total": 99.9,
        "ativo": true
      },
      {
        "id": 90002,
        "descricao": "APP DE STREAMING",
        "valor": 15,
        "quantidade": 1,
        "total": 15,
        "ativo": true
      }
    ],
    "acessos": [
      {
        "login": "cliente_12345",
        "senha": "senha-do-pppoe",
        "online": true,
        "ip": "100.64.10.20",
        "mac": "00:11:22:33:44:55",
        "sessao": {
          "inicio": "2026-10-01T06:12:40-03:00",
          "fim": null,
          "motivo_desconexao": null
        },
        "bloqueado": false,
        "plano_radius": "2024-FIBRA-500",
        "banda": {
          "download_mbps": 500,
          "upload_mbps": 250,
          "perfil_download": "500MBPS-DOWN",
          "perfil_upload": "250MBPS-UP"
        },
        "ip_fixo": null,
        "mac_cadastrado": null,
        "endereco_instalacao": "Rua das Flores 100 AP 201, Centro, Ed. Exemplo"
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou cliente.
404cliente_nao_encontradoO cliente não existe nesta base.
GET /api/v1/atendimento_anexo_baixar.php 🔑 requer chave · atendimentos:ler 👷 token do técnico 📎 devolve arquivo ▶ Baixar arquivo do anexo

Devolve o ARQUIVO, não

JSON: Content-Type do arquivo (image/jpeg, image/png, application/pdf, video/mp4…) e Content-Disposition com o nome. Os erros continuam em JSON. O id vem em "anexos" do atendimento_consultar.

Id de 1000000000 ou mais é arquivo do storage: aceita o cabeçalho Range (resposta 206), o que deixa adiantar vídeo; abaixo disso, anexo antigo do Vigo.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do anexo.

Exemplo

curl -s -OJ "https://sysimb.imbranet.com.br/api/v1/atendimento_anexo_baixar.php?base=1&id=123" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"
# -OJ salva com o nome que o servidor manda; os erros continuam vindo em JSON

Resposta

(conteúdo binário do arquivo)

Content-Type: image/jpeg
Content-Disposition: inline; filename="Foto da caixa.jpeg"

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou id.
404anexo_nao_encontradoNão existe nesta base.
POST /api/v1/atendimento_anexo_excluir.php 🔑 requer chave · atendimentos:gravar 👷 token do técnico ▶ Excluir anexo

Apaga um anexo — só o RESPONSÁVEL, e só de atendimento

ABERTO: depois de encerrado, o que foi anexado (assinatura, termo) faz parte do registro. Vale para os dois tipos de id (storage, 1000000000 ou mais, e Vigo); no storage apaga também as cópias iguais do mesmo arquivo na pasta.

🔐 Requer a permissão app_tecnico_usar (só do app — não libera nada nas telas) ou consultas_editar_os.

Parâmetros

NomeTipoObrigatórioDescrição
baseinteiroSim1 = Vigo 01, 2 = Vigo 02.
idinteiroSimId do anexo.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/atendimento_anexo_excluir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "base": 1,
  "id": 123
}'

Resposta

{
  "ok": true,
  "data": {
    "excluido": true,
    "id": 30001
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
405metodo_invalidoMétodo diferente de POST.
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação — entrar de novo.
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu (tecnico_logout) — entrar de novo.
403tecnico_inativoO usuário foi desativado no SysIMB.
403tecnico_sem_permissaoO usuário do técnico no SysIMB não tem a permissão do app (app_tecnico_usar) nem a da tela (consultas_editar_os) para excluir anexo. O login informa em "pode".
403nao_responsavelO técnico não é o responsável pelo atendimento (ou ele está sem responsável). Nada é gravado; "data.responsavel" diz de quem é. Quem abriu não importa.
400base_invalida"base" ausente ou diferente das bases do Vigo (1 = Vigo 01, 2 = Vigo 02).
503base_indisponivelA base do Vigo não respondeu — tentar de novo.
400parametro_ausenteFaltou id.
404anexo_nao_encontradoNão existe nesta base.
409atendimento_encerradoO atendimento já está encerrado.

📁 App do Técnico — Valores de Serviços

GET /api/v1/servicos_valores_listar.php 🔑 requer chave · servicos:consultar ▶ Listar a tabela de valores de serviços

A tabela de valores de serviços (Administrativo → Valores de Serviços), para o app do técnico mostrar quanto cobrar.

Cada serviço traz o "valor" padrão, a "unidade" pela qual se cobra (hora, metro ou unidade) e, se houver, uma "variacao" com nome e valor próprio — ex.: Rural (é o "Valor 2" da tela); sem variação, "variacao" vem null. Valores em decimal com ponto ("150.00"). Sem parâmetros vêm só os ATIVOS, em ordem de nome.

Não há exclusão: serviço que saiu da tabela é inativado — com todos=1 eles vêm junto, com "ativo": false, para o app que guarda a lista saber quais tirar. "meta.atualizado_em" é a alteração mais recente da tabela inteira (ativos e inativos): compare com o que guardou e só baixe de novo quando mudar. "meta.unidades" traz os rótulos para exibição.

"itens_incluidos" lista o que o valor do serviço já cobre de item ou cabo (ex.: "Mudança de endereço - Até 300 metros" inclui 300 metros de cabo drop): "quantidade" em "unidade" ("metro" para cabo controlado por bobina/caixa, "unidade" para os demais); o que o atendimento usar além disso é EXCEDENTE, a pagar — "excedente.servico_id"/"servico" diz por qual serviço da tabela o excedente é cobrado (valor por metro/unidade) e "excedente.material" = true soma também o material (valor de venda à vista do produto); os dois vazios = o excedente só é contado. Lista vazia = o serviço não inclui item. Não precisa do X-Tecnico-Token (a tabela é a mesma para todos). Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
buscastringNãoPedaço do nome do serviço, da variação ou da observação.
unidadestringNãohora | metro | unidade.
todosbooleanoNão1 = inclui os inativos (com "ativo": false). Padrão: só ativos.

Exemplo

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

Resposta

{
  "ok": true,
  "data": [
    {
      "id": 12,
      "servico": "Lançamento de cabo drop",
      "valor": "3.00",
      "unidade": "metro",
      "unidade_rotulo": "Metro",
      "variacao": {
        "nome": "Rural",
        "valor": "4.50"
      },
      "observacao": "Mínimo de 50 metros",
      "itens_incluidos": [],
      "ativo": true,
      "atualizado_em": "2026-10-13 09:40:12"
    },
    {
      "id": 15,
      "servico": "Hora técnica",
      "valor": "120.00",
      "unidade": "hora",
      "unidade_rotulo": "Hora",
      "variacao": null,
      "observacao": null,
      "itens_incluidos": [],
      "ativo": true,
      "atualizado_em": "2026-10-10 16:02:55"
    }
  ],
  "meta": {
    "total": 2,
    "atualizado_em": "2026-10-13 09:40:12",
    "unidades": [
      {
        "codigo": "hora",
        "rotulo": "Hora",
        "rotulo_plural": "Horas"
      },
      {
        "codigo": "metro",
        "rotulo": "Metro",
        "rotulo_plural": "Metros"
      },
      {
        "codigo": "unidade",
        "rotulo": "Unidade",
        "rotulo_plural": "Unidades"
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_invalido"unidade" diferente de hora, metro ou unidade.
GET /api/v1/servico_valor_consultar.php 🔑 requer chave · servicos:consultar ▶ Consultar um serviço

Um serviço da tabela de valores pelo ID (o mesmo número da tela Administrativo → Valores de Serviços), no mesmo formato de cada item da lista. Devolve também o serviço inativo, com "ativo": false — o app pode ter guardado um serviço que depois saiu da tabela; não ofereça para cobrança o que vier inativo.

"itens_incluidos" lista o que o valor do serviço já cobre de item ou cabo (ex.: "Mudança de endereço - Até 300 metros" inclui 300 metros de cabo drop): "quantidade" em "unidade" ("metro" para cabo controlado por bobina/caixa, "unidade" para os demais); o que o atendimento usar além disso é EXCEDENTE, a pagar — "excedente.servico_id"/"servico" diz por qual serviço da tabela o excedente é cobrado (valor por metro/unidade) e "excedente.material" = true soma também o material (valor de venda à vista do produto); os dois vazios = o excedente só é contado. Lista vazia = o serviço não inclui item. Não precisa do X-Tecnico-Token. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimID do serviço.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/servico_valor_consultar.php?id=123" \
  -H "Authorization: Bearer SUA_CHAVE"

Resposta

{
  "ok": true,
  "data": {
    "id": 12,
    "servico": "Lançamento de cabo drop",
    "valor": "3.00",
    "unidade": "metro",
    "unidade_rotulo": "Metro",
    "variacao": {
      "nome": "Rural",
      "valor": "4.50"
    },
    "observacao": "Mínimo de 50 metros",
    "itens_incluidos": [
      {
        "produto_id": 591,
        "produto": "CABO DROP INTELBRAS FIBERHOME 2KM",
        "quantidade": 300,
        "unidade": "metro",
        "excedente": {
          "servico_id": 1,
          "servico": "Lançamento Cabo FLAT",
          "material": false
        }
      }
    ],
    "ativo": true,
    "atualizado_em": "2026-10-13 09:40:12"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_invalido"id" ausente ou não inteiro positivo.
404nao_encontradoNão existe serviço com este ID.

📁 Estoque

GET /api/v1/estoque_produto_consultar.php 🔑 requer chave · estoque:consultar ▶ Consultar produto

Devolve um produto do estoque do SysIMB pelo ID (o mesmo número da tela Produtos): cadastro, categoria, saldo TOTAL e por LOCAL de armazenamento, situação diante do estoque mínimo e padrão, última compra, valor de venda, produtos do Vigo vinculados e, se pedido, os últimos movimentos.

"estoque.total" é a soma dos locais FÍSICOS (Principal, Itapema…) e é a mesma régua da Reposição; o que está em mãos dos funcionários (Reserva Funcionário) não entra no total nem em "estoque.locais".

"estoque.situacao" segue a tela Reposição: zerado (total 0), critico (total menor ou igual ao mínimo), baixo (abaixo do padrão) ou ok. "valor_venda" traz "a_vista" e "a_prazo" (decimal com ponto, ex.

"329.90"), definidos na tela Produtos → Editar; vem null quando o produto não tem valor de venda, e cada um vem null quando só o outro foi informado. Não confundir com "vigo[].preco_venda", que é o preço do cadastro do Vigo. Aceita GET ou POST.

Só responde produtos LIBERADOS na tela Produtos ("🔌 Disponível via API", desmarcado por padrão): os outros dão 403 produto_nao_liberado, mesmo com o ID certo. "api.permite_baixa" diz se o produto também aceita ajuste de estoque pelo estoque_ajustar ("📉 API permite baixa no estoque").

"bobinas" vem null em produto comum; em CABO controlado por bobina traz "controle" ("as" ou "drop"): nos dois o estoque é em METROS ("estoque.total" = soma das bobinas no estoque), "metragem_padrao" é a metragem de cada bobina na compra e "no_estoque" lista cada bobina (código, nome e metros que restam).

No "drop", que sai sempre com a bobina inteira, "com_tecnicos" lista as bobinas que estão com os técnicos, com os metros que restam e o técnico.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimID do produto no SysIMB.
movimentosinteiroNãoQuantos movimentos recentes trazer em "ultimos_movimentos", de 0 a 50. Padrão 0 (não traz). Não inclui cliente nem observação.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/estoque_produto_consultar.php?id=123" \
  -H "Authorization: Bearer SUA_CHAVE"

Resposta

{
  "ok": true,
  "data": {
    "id": 1234,
    "nome": "ROTEADOR WI-FI 6 AX1500",
    "descricao": "Roteador dual band para comodato",
    "status": "ativo",
    "ativo": true,
    "categoria": {
      "id": 7,
      "nome": "ROTEADOR",
      "possui_mac": true,
      "eh_ferramenta": false
    },
    "estoque": {
      "total": 42,
      "minimo": 10,
      "padrao": 30,
      "situacao": "ok",
      "quantidade_repor": 0,
      "locais": [
        {
          "id": 1,
          "nome": "Estoque Principal",
          "principal": true,
          "ativo": true,
          "quantidade": 35
        },
        {
          "id": 2,
          "nome": "Loja Centro",
          "principal": false,
          "ativo": true,
          "quantidade": 7
        }
      ]
    },
    "ultima_compra": {
      "data": "2026-09-15",
      "valor_unitario": "189.90",
      "fornecedor": {
        "id": 3,
        "nome": "Distribuidora Exemplo LTDA"
      }
    },
    "valor_venda": {
      "a_vista": "329.90",
      "a_prazo": "359.90"
    },
    "vigo": [
      {
        "id_vigo": 501,
        "referencia": "RT-AX1500",
        "descricao": "ROTEADOR WI-FI 6 AX1500",
        "preco_venda": "349.90",
        "preco_comodato": "290.00"
      }
    ],
    "imagem_url": "https://sysimb.exemplo.com.br/uploads/produtos/prod_exemplo.webp",
    "api": {
      "permite_baixa": true
    },
    "bobinas": null,
    "criado_em": "2026-01-10 09:15:00",
    "atualizado_em": "2026-09-15 14:02:11",
    "ultimos_movimentos": [
      {
        "id": 90001,
        "data_hora": "2026-10-01 10:20:00",
        "tipo": "saida",
        "tipo_saida": "contratacao_plano_wifi",
        "quantidade": 1,
        "local_origem_id": 1,
        "local_destino_id": null,
        "operador": "operador.exemplo",
        "via_api": false,
        "referencia": null
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_invalido"id" ausente ou não inteiro, ou "movimentos" fora de 0 a 50.
404nao_encontradoNão existe produto com este ID.
405metodo_invalidoMétodo diferente de GET e POST.
500erro_internoFalha ao consultar o banco.
403produto_nao_liberadoO produto existe, mas não está marcado como "Disponível via API" na tela Produtos.
POST /api/v1/estoque_ajustar.php 🔑 requer chave · estoque:ajustar 🔒 não vem no * ▶ Ajustar quantidade em estoque

Altera a quantidade em estoque de um produto — o mesmo AJUSTE da tela Estoque → Ajuste: grava um movimento do tipo "ajuste" com o motivo e o saldo anterior e novo, atualiza o estoque e registra na auditoria.

Duas formas, uma OU outra: "quantidade" define o saldo final (contagem física: "tem 12") e "variacao" soma ou subtrai do saldo atual (+5, -2). O ajuste vale para um LOCAL de armazenamento (padrão: Estoque Principal); nenhum local pode ficar negativo.

ATENÇÃO: o escopo estoque:ajustar NÃO vem no "*" — precisa estar marcado na chave. Use "referencia" para poder reenviar com segurança: a mesma referencia enviada de novo pela mesma chave devolve o ajuste já feito ("repetido": true) sem lançar outra vez. Se o saldo já for o informado, nada é lançado e volta "alterado": false.

Só produtos LIBERADOS na edição do produto, com as duas caixas marcadas (desmarcadas por padrão): sem "🔌 Disponível via API" dá 403 produto_nao_liberado; sem "📉 API permite baixa no estoque" dá 403 produto_sem_baixa_api. Vale para qualquer ajuste, somando ou subtraindo, e nada é gravado. A consulta do produto diz em "api.permite_baixa" se ele aceita ajuste.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimID do produto no SysIMB.
quantidadeinteiroSim, se não mandar variacaoSaldo FINAL do produto no local (0 ou mais).
variacaointeiroSim, se não mandar quantidadeQuanto somar (positivo) ou subtrair (negativo) do saldo atual do local. Diferente de zero.
motivotextoSimMotivo do ajuste, até 150 caracteres. Os da tela: "Inventário/Contagem física", "Perda/Avaria", "Produto vencido", "Erro de lançamento anterior", "Devolução de cliente", "Transferência entre unidades" — ou texto livre.
observacaotextoNãoDetalhes do ajuste (até 2000 caracteres). Aparece no histórico de movimentação.
local_idinteiroNãoLocal de armazenamento FÍSICO. Padrão: o Estoque Principal. Os IDs e saldos de cada local vêm em estoque.locais da consulta do produto. O local de um funcionário não aceita ajuste (404 local_nao_encontrado).
operador_logintextoNãoLogin do operador do SysIMB que fez o ajuste (precisa estar ativo). Sem ele, o ajuste fica em nome de quem criou a chave de API.
referenciatextoNãoIdentificador do ajuste no seu sistema, até 64 caracteres (letras, números e . _ : / -). Recomendado: torna o reenvio seguro.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/estoque_ajustar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 123,
  "variacao": -1,
  "motivo": "Perda/Avaria",
  "referencia": "ajuste-0001"
}'

Resposta

{
  "ok": true,
  "data": {
    "alterado": true,
    "repetido": false,
    "movimento_id": 90002,
    "referencia": "INV-2026-10-001",
    "produto": {
      "id": 1234,
      "nome": "ROTEADOR WI-FI 6 AX1500"
    },
    "local": {
      "id": 1,
      "nome": "Estoque Principal",
      "principal": true
    },
    "saldo_local_anterior": 35,
    "saldo_local_novo": 33,
    "variacao": -2,
    "estoque_total_atual": 40,
    "operador": "operador.exemplo",
    "data_hora": "2026-10-06 12:04:03"
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_invalido"id" inválido; "quantidade" e "variacao" juntos ou nenhum dos dois; quantidade negativa; variacao zero; "local_id" ou "referencia" fora do formato.
400motivo_ausenteFaltou o "motivo".
403sem_escopoA chave não tem o escopo estoque:ajustar marcado. O "*" não concede este escopo.
404nao_encontradoNão existe produto com este ID.
404local_nao_encontradoNão existe local de armazenamento FÍSICO com este local_id (local de funcionário também cai aqui).
405metodo_invalidoMétodo diferente de POST.
409referencia_em_usoEsta chave já usou a referencia em OUTRO produto, ou dois envios com a mesma referencia chegaram ao mesmo tempo. Nada foi lançado por esta chamada.
422saldo_insuficienteA variação deixaria o local com saldo negativo. A mensagem traz o saldo atual.
422local_inativoO local de armazenamento está desativado.
422operador_invalidooperador_login não existe ou está inativo no SysIMB.
500erro_internoFalha ao gravar. Nada foi alterado (a operação é feita de uma vez só).
403produto_nao_liberadoO produto existe, mas não está marcado como "Disponível via API" na tela Produtos.
403produto_sem_baixa_apiO produto está na API, mas não tem "API permite baixa no estoque" marcado — só consulta.
GET /api/v1/estoque_funcionarios_listar.php 🔑 requer chave · estoque:consultar 👷 aceita token do técnico ▶ Equipamentos com funcionários

O que a tela Estoque com Funcionários mostra: os equipamentos e materiais que saíram do estoque para funcionários (reserva, uso no trabalho, empréstimo) e a situação de cada um — em_uso (em mãos), vinculado (instalado em cliente), utilizado (gasto no trabalho) ou devolvido. Sem filtro de status traz só o que está EM MÃOS, como a tela. Empréstimo em mãos há o prazo configurado ou mais vem com emprestimo.atrasado = true.

Filtrando um funcionário (funcionario_id ou operador_login) vem também o KIT PADRÃO dele: quanto deve ter de cada produto, quanto tem em mãos e quanto falta repor. Com pendencias=1 vem a aba "Ação necessária": empréstimos atrasados e reposições do kit (de todos, ou só do funcionário filtrado).

"resumo" traz os números do cabeçalho da tela (do funcionário, quando filtrado). vinculo.cliente_id é o ID do cliente no Vigo.

"itens_uso" traz os produtos que CONSTAM com o funcionário SEM quantidade: saída "Uso para Trabalho" de produto marcado "Disponível via API" (ex.: conector) — repetir a saída não soma, continua um item, e ele sai pelo botão "Remover item" da tela; só produtos ainda Disponíveis via API e, com funcionario_id/operador_login, só os dele.

"bobinas_drop" traz as bobinas de cabo DROP com os técnicos (cada uma com o ID que ganhou ao sair do estoque e os metros que restam): é o "bobina_id" do estoque_bobina_baixar.

Cada bobina traz "codigo" (ID do cabo + "-B" + número da bobina, ex.: 591-B12 = BOBINA 12 do produto 591 — é o que vai no QR Code da etiqueta, e nunca se confunde com o QR de um produto, que é só o número) e "nome" ("BOBINA 12 - <cabo>"). Bobina que zerou sai da lista. APP DO

TÉCNICO: com o header X-Tecnico-Token (o token do tecnico_login), a lista é sempre a do técnico do token — com o kit padrão, os itens de uso e as bobinas de drop dele —, sem precisar de funcionario_id nem operador_login; se vier funcionario_id ou login de outra pessoa junto do token, 403 tecnico_divergente. Lista paginada. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
funcionario_idinteiroNãoSó os itens deste funcionário (ID do funcionário no SysIMB). Inclui kit_padrao e funcionario na resposta.
operador_logintextoNãoAlternativa ao funcionario_id: o login do operador do SysIMB, que é vinculado ao funcionário. Não use os dois. Aceita também o nome "tecnico_login". Com o header X-Tecnico-Token não precisa.
statustextoNãoem_uso (padrão), vinculado, utilizado, devolvido ou todos.
tipotextoNãoreserva_funcionario, uso_trabalho, emprestimo ou todos (padrão).
produto_idinteiroNãoSó deste produto (ID do SysIMB, o mesmo da consulta de produto).
mactextoNãoBusca pelo MAC, inteiro ou parte (mínimo 4 caracteres hexadecimais; com ou sem ":" e "-"). Combine com status=todos para achar o equipamento em qualquer situação.
saida_dedataNãoSaída do estoque a partir desta data (AAAA-MM-DD).
saida_atedataNãoSaída do estoque até esta data (AAAA-MM-DD).
pendenciasbooleanoNão1 = inclui "pendencias" (empréstimos atrasados e reposições do kit).
limiteinteiroNãoItens por página, de 1 a 500. Padrão 100.
paginainteiroNãoPágina, a partir de 1. "paginas" na resposta diz quantas há.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/estoque_funcionarios_listar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "filtros": {
      "funcionario_id": 21,
      "status": "em_uso",
      "tipo": "todos",
      "produto_id": null,
      "mac": null,
      "saida_de": null,
      "saida_ate": null
    },
    "total": 2,
    "pagina": 1,
    "limite": 100,
    "paginas": 1,
    "itens": [
      {
        "id": 5001,
        "tipo": "reserva_funcionario",
        "tipo_label": "Reserva Funcionário",
        "status": "em_uso",
        "status_label": "Em mãos",
        "produto": {
          "id": 1234,
          "nome": "ONU GPON EXEMPLO"
        },
        "mac": "AA:BB:CC:00:11:22",
        "serial": null,
        "quantidade": 1,
        "funcionario": {
          "id": 21,
          "nome": "Técnico Exemplo"
        },
        "saida": {
          "data": "2026-09-20 08:30:00",
          "dias": 17,
          "destino": "Reserva técnico",
          "operador": "operador.exemplo",
          "movimento_id": 90010
        },
        "emprestimo": null,
        "vinculo": null,
        "uso": null,
        "devolucao": null
      },
      {
        "id": 5002,
        "tipo": "emprestimo",
        "tipo_label": "Empréstimo",
        "status": "em_uso",
        "status_label": "Em mãos",
        "produto": {
          "id": 2345,
          "nome": "PARAFUSADEIRA EXEMPLO"
        },
        "mac": null,
        "serial": null,
        "quantidade": 1,
        "funcionario": {
          "id": 21,
          "nome": "Técnico Exemplo"
        },
        "saida": {
          "data": "2026-10-01 14:00:00",
          "dias": 6,
          "destino": "vai devolver",
          "operador": "operador.exemplo",
          "movimento_id": 90011
        },
        "emprestimo": {
          "prazo_dias": 2,
          "atrasado": true,
          "avisos_enviados": 1,
          "ultimo_aviso_em": "2026-10-04 09:00:00"
        },
        "vinculo": null,
        "uso": null,
        "devolucao": null
      }
    ],
    "resumo": {
      "em_uso": 2,
      "vinculados": 40,
      "utilizados": 1,
      "devolvidos": 3,
      "itens_em_maos": 2,
      "prazo_emprestimo_dias": 2
    },
    "funcionario": {
      "id": 21,
      "nome": "Técnico Exemplo",
      "status": "ativo"
    },
    "kit_padrao": [
      {
        "produto": {
          "id": 3456,
          "nome": "ROTEADOR WI-FI EXEMPLO"
        },
        "padrao": 2,
        "em_maos": 0,
        "repor": 2,
        "estoque_geral": 15,
        "observacao": null
      }
    ],
    "itens_uso": [
      {
        "id": 12,
        "funcionario": {
          "id": 21,
          "nome": "Técnico Exemplo"
        },
        "produto": {
          "id": 907,
          "nome": "CONECTOR FIBRA ROSCA APC (VERDE)"
        },
        "desde": "2026-10-17 09:12:00",
        "ultima_saida": "2026-10-17 15:40:00"
      }
    ],
    "bobinas_drop": [
      {
        "id": 88,
        "codigo": "591-B12",
        "numero": "BOBINA 12",
        "nome": "BOBINA 12 - CABO DROP 1F 2KM",
        "metragem_inicial": 2000,
        "metragem_atual": 1340,
        "status": "funcionario",
        "funcionario": {
          "id": 21,
          "nome": "Técnico Exemplo"
        },
        "desde": "2026-10-10 08:00:00",
        "produto": {
          "id": 591,
          "nome": "CABO DROP 1F 2KM"
        }
      }
    ],
    "pendencias": {
      "emprestimos_atrasados": [
        {
          "id": 5002,
          "funcionario": {
            "id": 21,
            "nome": "Técnico Exemplo"
          },
          "produto": {
            "id": 2345,
            "nome": "PARAFUSADEIRA EXEMPLO"
          },
          "mac": null,
          "quantidade": 1,
          "data_saida": "2026-10-01 14:00:00",
          "dias": 6,
          "avisos_enviados": 1
        }
      ],
      "reposicoes": [
        {
          "funcionario": {
            "id": 21,
            "nome": "Técnico Exemplo"
          },
          "produto": {
            "id": 3456,
            "nome": "ROTEADOR WI-FI EXEMPLO"
          },
          "padrao": 2,
          "em_maos": 0,
          "repor": 2,
          "estoque_geral": 15
        }
      ]
    }
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_invalidoFiltro fora do formato: status ou tipo desconhecido, data fora de AAAA-MM-DD, limite fora de 1–500, mac curto, funcionario_id e operador_login juntos, ou operador_login e tecnico_login com valores diferentes.
401tecnico_token_invalidoX-Tecnico-Token desconhecido ou feito com outra chave — entrar de novo (tecnico_sessao_expirada: o login expirou).
403tecnico_divergenteVeio o token E um funcionario_id/operador_login/tecnico_login de outra pessoa. Com o token, a lista já é a do técnico.
404funcionario_nao_encontradofuncionario_id que não existe.
404operador_nao_encontradooperador_login que não existe.
405metodo_invalidoMétodo diferente de GET e POST.
422operador_sem_funcionarioO operador (do login ou do token) existe, mas não está vinculado a um funcionário no SysIMB.
500erro_internoFalha ao consultar o banco.
POST /api/v1/estoque_bobina_baixar.php 🔑 requer chave · estoque:bobina_baixar 🔒 não vem no * 👷 aceita token do técnico ▶ Baixar metros da bobina de drop

Baixa os METROS de cabo DROP usados pelo técnico — o mesmo botão "➖ Baixar metros" da tela Estoque com Funcionários. Vale igual para a CAIXA de cabo de rede (subcategoria CABOS DE REDE › CABO EM CAIXA, numero "CAIXA 01"), que funciona como o drop.

Cada bobina de drop tem um código desde que entra no estoque; ela sai INTEIRA para o técnico (saída "Uso para Trabalho"), continua com o mesmo código e vai sendo baixada até zerar; os IDs vêm em "bobinas_drop" do estoque_funcionarios_listar.

Quando zera, a bobina é encerrada ("zerou": true) e aparece "🧵 Repor bobina de drop" na aba Ação necessária da tela, até o técnico receber outra.

QUEM

BAIXA: no app do técnico, envie o header X-Tecnico-Token (o token do tecnico_login) — o técnico sai do login dele, a baixa é conferida (a bobina tem que estar com ele, senão 403 nao_e_do_tecnico) e gravada no nome dele, sem precisar de operador_login.

Sem o token, a integração pode mandar operador_login, que faz a mesma conferência; sem nenhum dos dois, a baixa fica em nome de quem criou a chave e não confere o dono.

Use "referencia" para poder reenviar com segurança: a mesma referencia pela mesma chave devolve a baixa já feita ("repetido": true) sem baixar de novo.

NOMES

ALTERNATIVOS: "idempotency_key" vale como "referencia", "base" vale como "atendimento_base" e "tecnico_login" vale como "operador_login" — mande um ou outro; os dois com valores diferentes dão 400. Só bobina de cabo marcado "🔌 Disponível via API".

Parâmetros

NomeTipoObrigatórioDescrição
bobina_idtextoSimID da bobina (bobinas_drop[].id do estoque_funcionarios_listar, ex.: 88) ou o código do QR Code da etiqueta (bobinas_drop[].codigo, ex.: "591-B12").
metrosinteiroSimMetros usados, inteiro maior que zero. Não pode passar do que resta na bobina.
operador_logintextoNãoLogin do técnico no SysIMB (ativo), para quem NÃO usa o token do técnico. Confere que a bobina é dele. Com o header X-Tecnico-Token não precisa; se vier, tem que ser o mesmo login do token. Aceita também o nome "tecnico_login".
cliente_idinteiroNãoID do cliente no Vigo onde o cabo foi usado.
atendimento_baseinteiroNãoBase do Vigo do atendimento (1 ou 2). Aceita também o nome "base". Com atendimento_id, VINCULA a baixa à OS (1.12.1375): o cabo aparece no bloco Materiais da OS e em vinculados (grupo "cabos") e conta no excedente dos serviços. Sem os dois, a baixa fica só no histórico da bobina.
atendimento_idinteiroNãoID do atendimento no Vigo. Mande sempre que a baixa for de uma OS (junto com atendimento_base).
observacaotextoNãoTexto livre (até 255 caracteres), aparece no histórico da bobina.
referenciatextoNãoIdentificador da baixa no app, até 64 caracteres (letras, números e . _ : / -). Recomendado: torna o reenvio seguro. Aceita também o nome "idempotency_key" (ex.: um UUID).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/estoque_bobina_baixar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "bobina_id": "591-B12",
  "metros": 120,
  "atendimento_base": 1,
  "atendimento_id": 12345,
  "referencia": "os-12345-drop"
}'

Resposta

{
  "ok": true,
  "data": {
    "repetido": false,
    "bobina": {
      "id": 88,
      "codigo": "591-B12",
      "numero": "BOBINA 12",
      "nome": "BOBINA 12 - CABO DROP 1F 2KM",
      "metragem_inicial": 2000,
      "metragem_atual": 1220,
      "status": "funcionario",
      "funcionario": {
        "id": 21,
        "nome": "Técnico Exemplo"
      },
      "desde": "2026-10-10 08:00:00",
      "produto": {
        "id": 591,
        "nome": "CABO DROP 1F 2KM"
      }
    },
    "metros_baixados": 120,
    "saldo": 1220,
    "zerou": false
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
400parametro_invalido"bobina_id" ausente, "metros" não inteiro positivo, "referencia" fora do formato, ou um campo mandado com os dois nomes (referencia e idempotency_key, atendimento_base e base, operador_login e tecnico_login) com valores diferentes.
401tecnico_token_invalidoX-Tecnico-Token desconhecido ou feito com outra chave — entrar de novo (tecnico_sessao_expirada: o login expirou).
403nao_e_do_tecnicoA bobina está com outro funcionário (não o técnico do token ou do operador_login).
403tecnico_divergenteVeio o token E um operador_login/tecnico_login de outra pessoa. Com o token, não precisa mandar o login.
403sem_escopoA chave não tem o escopo estoque:bobina_baixar marcado. O "*" não concede este escopo.
403produto_nao_liberadoO cabo da bobina não está marcado "Disponível via API".
404nao_encontradoNão existe bobina de cabo DROP com este ID.
405metodo_invalidoMétodo diferente de POST.
409bobina_encerradaA bobina já zerou ou foi encerrada.
409referencia_em_usoA referencia já foi usada por esta chave em OUTRA bobina, ou chegou duas vezes ao mesmo tempo.
422metragem_insuficienteOs metros passam do que resta na bobina. A mensagem diz quanto resta.
422operador_invalidooperador_login (ou tecnico_login) não existe ou está inativo.
422operador_sem_funcionarioO usuário do token não está vinculado a um funcionário no SysIMB.
500erro_internoFalha ao gravar. Nada foi baixado.

📁 App do Técnico — Prédios

GET /api/v1/predios_listar.php 🔑 requer chave · predios:ler 👷 token do técnico ▶ Achar o prédio

Procura prédios de fibra por um de três caminhos: "q" (nome ou endereço, 3+ caracteres — "santa monica" acha "Ed.

Santa Mônica - Bloco A"); "lat" + "lng" (os prédios em volta do técnico, do mais perto para o mais longe); ou "cliente_id" + "base" (o prédio em que o cliente está vinculado — para abrir o prédio a partir da OS).

Com mais de um, vale nesta ordem: cliente, q, coordenada; "lat" + "lng" junto de "q" só acrescenta a distância. Devolve o resumo de cada prédio; o conteúdo completo é do predio_detalhar. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
qstringUm dos três caminhosNome do prédio ou endereço (3+ caracteres). Sem acento e sem maiúscula também acha.
latnúmeroUm dos três caminhosLatitude do técnico em graus decimais. Sempre junto de "lng".
lngnúmeroUm dos três caminhosLongitude do técnico em graus decimais.
raio_minteiroNãoRaio da busca por coordenada, em metros (50 a 5000). Padrão 500.
cliente_idinteiroUm dos três caminhosId do cliente no Vigo. Sempre junto de "base".
baseinteiroSim, com cliente_id1 = Vigo 01, 2 = Vigo 02 (a mesma "base" dos atendimentos).
limiteinteiroNãoMáximo de prédios na resposta (1 a 50). Padrão 20.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/predios_listar.php?q=edificio+exemplo" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "criterio": "texto",
    "total": 1,
    "predios": [
      {
        "id": 42,
        "nome": "Edifício Exemplo",
        "endereco": "Rua Exemplo 500",
        "complemento": null,
        "bloco": "A",
        "bairro": "Centro",
        "cidade": "Cidade Exemplo",
        "uf": "SC",
        "tipo_instalacao": "cabo_rede",
        "tipo_instalacao_label": "Cabo de Rede no Apartamento",
        "status": "ativo",
        "status_label": "Ativo",
        "latitude": -27.0001,
        "longitude": -48.6001,
        "mapa_url": "https://www.google.com/maps?q=-27.0001%2C-48.6001",
        "tem_alerta": true,
        "alerta": "01/09/2026 — Portaria só libera a subida com aviso prévio.",
        "equipamentos": 3,
        "clientes": 12,
        "distancia_m": null
      }
    ]
  }
}

Campos da resposta

CampoTipoO que é
criteriostringcliente | texto | proximidade — qual caminho respondeu.
predios[].tipo_instalacaostring|nullfibra_apartamento | cabo_rede | tipo_casa (tipo_instalacao_label traz o texto).
predios[].statusstringativo | em_ativacao | inativo | sem_viabilidade.
predios[].latitude / .longitudenúmero|nullCoordenada do prédio. null em prédio ainda sem coordenada — o mapa_url então abre o endereço escrito.
predios[].alertastring|nullTexto das mensagens de alerta do prédio (as anotações de alerta, cada uma com a data). Mostre em destaque.
predios[].distancia_minteiro|nullMetros, em linha reta, do ponto informado. Só com lat + lng; null se o prédio não tem coordenada.

Resposta — nada encontrado

Não achar não é erro: HTTP 200 com a lista vazia.

{
  "ok": true,
  "data": {
    "criterio": "proximidade",
    "total": 0,
    "predios": []
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteNenhum dos três caminhos veio (q, lat + lng, cliente_id + base).
400parametro_invalido"q" com menos de 3 caracteres, ou lat/lng que não são coordenadas.
400base_invalida"cliente_id" sem "base", ou base que não existe.
405metodo_invalidoMétodo diferente de GET e POST.
GET /api/v1/predio_detalhar.php 🔑 requer chave · predios:ler 👷 token do técnico ▶ Abrir o prédio (tudo de uma vez)

Tudo o que a página do prédio mostra, numa chamada: 📍 informações, as quatro listas de anotações datadas (🖥️ Observação NOC, 📝 Observações Técnicas, 🤝 Negociações com o Condomínio, ⚠️ Mensagem de alerta para vendedoras), 🔧 equipamentos, 👥 clientes (com a situação da conexão no RADIUS e os chamados de suporte dos últimos 30 dias) e 📜 histórico. "pode" diz o que este técnico pode fazer, para o app esconder o botão que daria 403.

SINCRONIZAÇÃO: ao abrir, os clientes são conferidos com o Vigo no máximo de 5 em 5 minutos — cancelado e quem mudou de endereço saem do prédio; "sincronizar": 1 força agora. "leve": 1 pula Vigo e RADIUS (resposta em milissegundos, sem "conexao" e sem "suporte_30d" nos clientes) — use para recarregar depois de gravar. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
sincronizarbooleanoNão1 = confere os clientes com o Vigo agora, sem esperar os 5 minutos.
levebooleanoNão1 = sem Vigo e sem RADIUS: não sincroniza e os clientes vêm sem "conexao" e sem "suporte_30d".
historico_limiteinteiroNãoQuantos registros do histórico (1 a 200). Padrão 30, do mais novo para o mais antigo.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/predio_detalhar.php?id=42" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "predio": {
      "id": 42,
      "nome": "Edifício Exemplo",
      "endereco": "Rua Exemplo 500",
      "complemento": null,
      "bloco": "A",
      "bairro": "Centro",
      "cidade": "Cidade Exemplo",
      "uf": "SC",
      "tipo_instalacao": "cabo_rede",
      "tipo_instalacao_label": "Cabo de Rede no Apartamento",
      "status": "ativo",
      "status_label": "Ativo",
      "latitude": -27.0001,
      "longitude": -48.6001,
      "mapa_url": "https://www.google.com/maps?q=-27.0001%2C-48.6001",
      "tem_alerta": true,
      "endereco_vigo": "Rua Exemplo 500 Bl A",
      "sindico": {
        "nome": "Fulano Síndico",
        "contato": "(47) 90000-0000",
        "dados_de": "2025-08-01",
        "meses": 15,
        "desatualizado": true
      },
      "caixa_trancada": true,
      "consultar_noc": false,
      "primeiro_cliente": {
        "cliente_id": "1001",
        "base_nome": "Vigo 01",
        "nome": "Cliente Exemplo",
        "data": "2024-03-15"
      },
      "estrutura": {
        "andares_apartamentos": 10,
        "apartamentos_por_andar": 4,
        "andares_social": 2,
        "total_unidades": 40,
        "clientes_vinculados": 12,
        "percentual_atendimento": 30
      },
      "cadastrado_em": "2024-03-10T09:15:00",
      "cadastrado_por": "Operador Exemplo"
    },
    "anotacoes": [
      {
        "campo": "noc",
        "titulo": "🖥️ Observação NOC",
        "ajuda": "O que o NOC precisa saber antes de mexer neste prédio.",
        "editavel": false,
        "itens": []
      },
      {
        "campo": "observacoes",
        "titulo": "📝 Observações Técnicas",
        "ajuda": "Informações importantes para o técnico quando for instalar.",
        "editavel": true,
        "itens": [
          {
            "id": 501,
            "texto": "Chave do shaft fica com o zelador.",
            "data": "2026-10-02",
            "data_aproximada": false,
            "autor": "Técnico Exemplo",
            "criado_em": "2026-10-02T14:20:00",
            "editado_por": null,
            "editado_em": null
          }
        ]
      },
      {
        "campo": "negociacoes",
        "titulo": "🤝 Negociações com o Condomínio",
        "ajuda": "Acordos, contratos, condições especiais, datas de renovação.",
        "editavel": false,
        "itens": []
      },
      {
        "campo": "alerta",
        "titulo": "⚠️ Mensagem de alerta para VENDEDORAS",
        "ajuda": "Informação importante para o setor de vendas. Aparece em destaque aqui, no cadastro de cliente e no prospecto de vendas.",
        "editavel": false,
        "itens": [
          {
            "id": 480,
            "texto": "Portaria só libera a subida com aviso prévio.",
            "data": "2026-09-01",
            "data_aproximada": false,
            "autor": "Operador Exemplo",
            "criado_em": "2026-09-01T10:00:00",
            "editado_por": null,
            "editado_em": null
          }
        ]
      }
    ],
    "equipamentos": [
      {
        "id": 3101,
        "produto_id": 12,
        "produto": "ONU GPON EXEMPLO",
        "categoria": "ONU",
        "onu": true,
        "mac": "AA:BB:CC:00:00:01",
        "serial": "EXMP00000001",
        "vlan": { "id": 40, "numero": 2001, "descricao": "Vlans para Prédios" },
        "porta_pon": "Fabricante OLT_01 - Slot 1 / Porta 2",
        "localizacao": "Shaft do 3º andar",
        "observacao": null,
        "data_instalacao": "2026-05-10",
        "status": "ativo",
        "status_label": "Ativo"
      }
    ],
    "clientes": [
      {
        "id": 7001,
        "cliente_id": 1001,
        "base": 1,
        "base_nome": "Vigo 01",
        "nome": "Cliente Exemplo",
        "login": "cliente_exemplo",
        "situacao": "L",
        "situacao_label": "Liberado",
        "endereco": "Rua Exemplo 500 Bl A Apto 301",
        "telefone": null,
        "celular": "47900000000",
        "conexao": {
          "online": true,
          "ip": "100.64.0.10",
          "tempo_online": "2d 4h",
          "ultima_desconexao": null,
          "vlan": 2001
        },
        "suporte_30d": {
          "total": 3,
          "ultimo": "2026-11-12",
          "tipos": [
            { "tipo": "SEM INTERNET", "quantidade": 2 },
            { "tipo": "LENTIDÃO", "quantidade": 1 }
          ]
        }
      }
    ],
    "historico": [
      {
        "id": 9001,
        "tipo": "equipamento_trocado",
        "tipo_label": "Equipamento Trocado",
        "icone": "🔁",
        "cor": "#7b1fa2",
        "descricao": "Equipamento trocado: saiu ONU GPON EXEMPLO (SN: EXMP00000009) → entrou ONU GPON EXEMPLO (SN: EXMP00000001) - Local: Shaft do 3º andar - Origem: Estoque do técnico Técnico Exemplo (item #88) - Motivo: ONU queimada",
        "data_hora": "2026-11-18T16:42:10",
        "operador": "Técnico Exemplo"
      }
    ],
    "sincronizacao": {
      "vigo_disponivel": true,
      "executada": true,
      "removidos_cancelados": 0,
      "removidos_endereco": 0,
      "atualizados": 1,
      "ultima": "2026-11-20T09:48:20",
      "proxima_em_min": null
    },
    "pode": {
      "ver": true,
      "anotar": true,
      "clientes": true,
      "equipamentos": true
    }
  }
}

Campos da resposta

CampoTipoO que é
predio.endereco_vigostringO endereço do prédio como o Vigo o escreve (rua + número + " Bl " + bloco). É o valor inicial da busca de clientes.
predio.sindico.dados_de / .meses / .desatualizadodata|null, inteiro|null, boolDe quando é o nome/contato do síndico e há quantos meses. desatualizado = 12 meses ou mais: mostre "vale confirmar com o condomínio".
predio.caixa_trancadabooltrue = a caixa do prédio fica trancada (o técnico precisa da chave).
predio.estruturaobjeto|nullAndares e apartamentos. percentual_atendimento = clientes vinculados ÷ total de unidades (a tela pinta ≥ 70 verde, ≥ 30 laranja, menos que isso vermelho). null quando o prédio não tem a estrutura cadastrada.
anotacoes[]listaSempre as quatro listas, nesta ordem. Cada anotação tem a data em que a informação foi vista — é ela que diz se ainda vale. Itens do mais novo para o mais antigo.
anotacoes[].editavelbooltrue só em "observacoes" (📝 Observações Técnicas) e só se o técnico pode anotar. As outras três são só leitura no app.
anotacoes[].itens[].data_aproximadabooltrue = anotação antiga, importada antes do controle por data: a data é aproximada — mostre "(aprox.)".
anotacoes (campo "alerta")—Havendo itens, mostre em destaque no topo da tela do prédio, em qualquer aba: é para ninguém entrar no prédio sem ler.
equipamentos[].idinteiroId do equipamento NO PRÉDIO — é o "equipamento_id" de editar, remover e trocar.
equipamentos[].onubooltrue = ONU/ONT (decidido pela categoria do produto): serial de 12 caracteres obrigatório, e só ela tem VLAN e porta PON.
equipamentos[].mac / .serialstring|nullMAC no formato AA:BB:CC:DD:EE:FF; serial em maiúsculas. null quando o equipamento não tem.
equipamentos[].vlanobjeto|nullVLAN da ONU (id, numero, descricao). null em equipamento que não é ONU ou em ONU sem VLAN definida.
equipamentos[].porta_ponstring|nullPorta da OLT, já em texto. Vem da VLAN: o app não escolhe a porta.
equipamentos[].statusstringativo | inativo | manutencao (status_label traz o texto).
clientes[].idinteiroId do vínculo (uma linha por LOGIN PPPoE: cliente com dois logins aparece duas vezes).
clientes[].cliente_id + .baseinteiroO cliente no Vigo — os mesmos "id do cliente" e "base" dos atendimentos.
clientes[].situacaostring|nullL = Liberado, B = Bloqueado (destaque o bloqueado). Cancelado não aparece: sai do prédio na sincronização.
clientes[].conexao.onlinebool|nulltrue = conectado agora (vêm ip e tempo_online); false = desconectado (vem ultima_desconexao); null = o RADIUS não tem dado deste login. Ausente com leve=1.
clientes[].suporte_30dobjetoChamados de suporte do cliente em 30 dias. Muito chamado num prédio aponta problema no prédio, não no cliente (a tela pinta 0 cinza, 1–2 amarelo, 3+ vermelho). Ausente com leve=1 ou sem o Vigo.
historico[]listaQuem fez o quê no prédio. icone e cor são os da tela, para o app desenhar igual.
sincronizacao.proxima_em_mininteiro|nullMinutos até a próxima conferência automática com o Vigo. null = acabou de sincronizar ou já pode.
podeobjetoO que este técnico pode: ver, anotar (Observações Técnicas), clientes (vincular) e equipamentos (inserir, editar, remover, trocar).

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
405metodo_invalidoMétodo diferente de GET e POST.
POST /api/v1/predio_anotacao_inserir.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Anotar em Observações Técnicas

Acrescenta uma anotação datada em 📝 Observações Técnicas — a única das quatro listas em que o técnico escreve pelo app. A anotação entra no histórico do prédio e aparece na hora na tela do escritório. Devolve a lista do campo já atualizada.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
textostringSimA anotação. Aceita quebra de linha e emoji.
datadataNãoAAAA-MM-DD de quando a informação foi vista. Padrão: hoje. Não pode ser futura.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_anotacao_inserir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 42,
  "texto": "Chave do shaft fica com o zelador."
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Anotação registrada.",
    "anotacao_id": 501,
    "campo": "observacoes",
    "itens": [
      {
        "id": 501,
        "texto": "Chave do shaft fica com o zelador.",
        "data": "2026-11-20",
        "data_aproximada": false,
        "autor": "Técnico Exemplo",
        "criado_em": "2026-11-20T10:05:00",
        "editado_por": null,
        "editado_em": null
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400parametro_invalido"data" fora do formato AAAA-MM-DD.
422data_futuraA data é depois de hoje.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
POST /api/v1/predio_anotacao_editar.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Corrigir uma anotação

Corrige o texto (e, se vier, a data) de uma anotação de 📝 Observações Técnicas. O texto anterior fica no histórico do prédio. Anotação das outras três listas é recusada (campo_nao_permitido).

Parâmetros

NomeTipoObrigatórioDescrição
anotacao_idinteiroSimanotacoes[].itens[].id.
textostringSimO texto corrigido (inteiro).
datadataNãoAAAA-MM-DD. Sem ela, a data fica como está.
idinteiroNãoId do prédio. Se vier, a anotação tem de ser dele (proteção contra id trocado).

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_anotacao_editar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "anotacao_id": 501,
  "texto": "Chave do shaft fica com o zelador (apto 101)."
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Anotação corrigida.",
    "anotacao_id": 501,
    "campo": "observacoes",
    "itens": [
      {
        "id": 501,
        "texto": "Chave do shaft fica com o zelador (apto 101).",
        "data": "2026-11-20",
        "data_aproximada": false,
        "autor": "Técnico Exemplo",
        "criado_em": "2026-11-20T10:05:00",
        "editado_por": "Técnico Exemplo",
        "editado_em": "2026-11-20T10:12:00"
      }
    ]
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "anotacao_id" ou "texto".
404anotacao_nao_encontradaAnotação não existe (ou é de outro prédio, quando "id" veio).
403campo_nao_permitidoA anotação é de NOC, Negociações ou Alerta: pelo app só se altera Observações Técnicas.
422data_futuraA data é depois de hoje.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
POST /api/v1/predio_anotacao_excluir.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Excluir uma anotação

Exclui uma anotação de 📝 Observações Técnicas. O texto vai para o histórico do prédio antes de sumir. Peça confirmação ao técnico antes de chamar.

Parâmetros

NomeTipoObrigatórioDescrição
anotacao_idinteiroSimanotacoes[].itens[].id.
idinteiroNãoId do prédio. Se vier, a anotação tem de ser dele.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_anotacao_excluir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "anotacao_id": 501
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Anotação excluída.",
    "anotacao_id": null,
    "campo": "observacoes",
    "itens": []
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "anotacao_id".
404anotacao_nao_encontradaAnotação não existe (ou é de outro prédio, quando "id" veio).
403campo_nao_permitidoA anotação é de NOC, Negociações ou Alerta.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
GET /api/v1/predio_clientes_buscar.php 🔑 requer chave · predios:ler 👷 token do técnico ▶ Procurar clientes para vincular

Lista os clientes do Vigo (das duas bases) cujo endereço contém o texto pesquisado, um item por LOGIN PPPoE — o vínculo do prédio é sempre por login. Sem "endereco", procura pelo endereço do próprio prédio (predio.endereco_vigo). Cada item diz se já está neste prédio, se está em outro e se pode ser vinculado. Cliente cancelado não aparece. Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
enderecostringNãoTrecho do endereço como está no Vigo (4+ caracteres). Padrão: o endereço do prédio.

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/predio_clientes_buscar.php?id=42" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "endereco_pesquisado": "Rua Exemplo 500 Bl A",
    "endereco_do_predio": "Rua Exemplo 500 Bl A",
    "total": 2,
    "clientes": [
      {
        "cliente_id": 1002,
        "base": 1,
        "base_nome": "Vigo 01",
        "nome": "Cliente Novo Exemplo",
        "endereco": "Rua Exemplo 500 Bl A Apto 502",
        "cidade": "CIDADE EXEMPLO",
        "login": "cliente_novo",
        "ja_vinculado": false,
        "outro_predio": null,
        "pode_vincular": true
      },
      {
        "cliente_id": 1003,
        "base": 1,
        "base_nome": "Vigo 01",
        "nome": "Cliente Sem Login Exemplo",
        "endereco": "Rua Exemplo 500 Bl A Apto 601",
        "cidade": "CIDADE EXEMPLO",
        "login": null,
        "ja_vinculado": false,
        "outro_predio": null,
        "pode_vincular": false
      }
    ]
  }
}

Campos da resposta

CampoTipoO que é
clientes[].loginstring|nullLogin PPPoE. null = o cliente existe no endereço mas não tem login no RADIUS: aparece só para constar, não entra no prédio.
clientes[].ja_vinculadoboolEste login já está neste prédio.
clientes[].outro_prediostring|nullNome do prédio em que este login (ou este cliente) já está. Não impede vincular aqui — avise o técnico.
clientes[].pode_vincularboolfalse quando não tem login ou já está neste prédio: desabilite a seleção.

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400parametro_invalidoEndereço com menos de 4 caracteres.
503vigo_indisponivelO Vigo não respondeu. Tente de novo.
503radius_indisponivelO RADIUS não respondeu: sem ele não dá para conferir os logins, e a busca fica bloqueada.
405metodo_invalidoMétodo diferente de GET e POST.
POST /api/v1/predio_clientes_vincular.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Vincular clientes ao prédio

Vincula ao prédio os logins escolhidos em predio_clientes_buscar. Cada item é um login PPPoE de um cliente; o SysIMB confere no RADIUS se o login é mesmo daquele cliente e busca nome, endereço e telefones no Vigo.

Login que já estava no prédio não é erro (conta em "ja_vinculados"); item que não passa na conferência volta em "recusados" com o motivo, sem impedir os outros. O app só

VINCULA: tirar cliente do prédio é do escritório e da sincronização com o Vigo. Até 100 logins por chamada.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
clienteslistaSimLista de { "cliente_id": inteiro, "base": 1 ou 2, "login": string } — exatamente os campos de predio_clientes_buscar.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_clientes_vincular.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 42,
  "clientes": [
    {
      "cliente_id": 1002,
      "base": 1,
      "login": "cliente_novo"
    }
  ]
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "1 login(s) vinculado(s) ao prédio.",
    "adicionados": 1,
    "ja_vinculados": 0,
    "recusados": [],
    "nomes": [
      "Cliente Novo Exemplo (cliente_novo)"
    ],
    "clientes": [
      {
        "id": 7002,
        "cliente_id": 1002,
        "base": 1,
        "base_nome": "Vigo 01",
        "nome": "Cliente Novo Exemplo",
        "login": "cliente_novo",
        "situacao": "L",
        "situacao_label": "Liberado",
        "endereco": "Rua Exemplo 500 Bl A Apto 502",
        "telefone": null,
        "celular": "47900000001"
      }
    ]
  }
}

Campos da resposta

CampoTipoO que é
recusados[]lista{ cliente_id, base, login, motivo } de cada item que não entrou (sem login, base inválida, login que não é daquele cliente no RADIUS).
clientes[]listaOs clientes do prédio depois da gravação, SEM "conexao" e "suporte_30d" — para tê-los, chame predio_detalhar.

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400parametro_invalidoMais de 100 logins na chamada.
503radius_indisponivelO RADIUS não respondeu: nada foi vinculado.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
GET /api/v1/predio_equipamento_opcoes.php 🔑 requer chave · predios:ler 👷 token do técnico ▶ Opções para inserir ou trocar equipamento

O que o formulário de equipamento precisa.

ORIGENS: de onde pode sair o equipamento que entra no prédio — "pendencia" (equipamento que já saiu do estoque com este prédio como destino), "funcionario" (o estoque do PRÓPRIO técnico do token: o que está com ele como Reserva Funcionário, menos material de consumo) e "sem_registro" (equipamento antigo ou doado que já estava no prédio: escolhe-se o produto da lista "produtos"). Saída direta do estoque da empresa não existe no app. Traz também as VLANs livres (só ONU/ONT usa) e os status do equipamento.

A lista de produtos é grande (centenas): chame ao abrir o formulário e guarde enquanto a tela estiver aberta; depois de inserir, trocar ou remover, peça de novo (o estoque do técnico e as VLANs mudam). Aceita GET ou POST.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).

Exemplo

curl -s "https://sysimb.imbranet.com.br/api/v1/predio_equipamento_opcoes.php?id=42" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO"

Resposta

{
  "ok": true,
  "data": {
    "origens": [
      {
        "origem": "pendencia",
        "titulo": "Pendência deste prédio",
        "descricao": "Equipamento que já saiu do estoque com este prédio como destino.",
        "disponivel": true,
        "itens": [
          {
            "pendencia_id": 310,
            "produto_id": 30,
            "produto": "SWITCH 8 PORTAS EXEMPLO",
            "categoria": "SWITCH",
            "onu": false,
            "mac": "AA:BB:CC:00:00:10",
            "serial": null,
            "retirado_por": "Técnico Exemplo",
            "data_saida": "2026-11-19T08:30:00"
          }
        ]
      },
      {
        "origem": "funcionario",
        "titulo": "Meu estoque",
        "descricao": "Equipamento que está com você. Sai do seu estoque quando entra no prédio.",
        "disponivel": true,
        "itens": [
          {
            "estoque_funcionario_id": 88,
            "produto_id": 12,
            "produto": "ONU GPON EXEMPLO",
            "categoria": "ONU",
            "onu": true,
            "exige_mac": true,
            "mac": "AA:BB:CC:00:00:01",
            "serial": "EXMP00000001",
            "quantidade": 1,
            "tipo": "reserva_funcionario",
            "data_saida": "2026-11-10T07:50:00"
          }
        ],
        "aviso": null
      },
      {
        "origem": "sem_registro",
        "titulo": "Já estava no prédio",
        "descricao": "Equipamento antigo ou doado, sem saída de estoque para dar baixa. Escolha o produto e informe MAC ou serial.",
        "disponivel": true,
        "itens": []
      }
    ],
    "produtos": [
      { "produto_id": 12, "produto": "ONU GPON EXEMPLO", "categoria": "ONU", "onu": true, "exige_mac": false },
      { "produto_id": 30, "produto": "SWITCH 8 PORTAS EXEMPLO", "categoria": "SWITCH", "onu": false, "exige_mac": true }
    ],
    "vlans_livres": [
      { "vlan_id": 41, "numero": 2002, "descricao": "Vlans para Prédios", "porta_pon": "Fabricante OLT_01 - Slot 1 - Porta 2" },
      { "vlan_id": 42, "numero": 2003, "descricao": null, "porta_pon": null }
    ],
    "status": [
      { "status": "ativo", "label": "Ativo" },
      { "status": "inativo", "label": "Inativo" },
      { "status": "manutencao", "label": "Manutenção" }
    ]
  }
}

Campos da resposta

CampoTipoO que é
origens[].disponivelboolfalse = nada para escolher nesta origem agora (sem pendência, estoque vazio). Mostre desabilitada; "aviso" explica quando há motivo.
origens[].itens[].pendencia_idinteiroNa origem "pendencia": vai como "pendencia_id" no inserir/trocar.
origens[].itens[].estoque_funcionario_idinteiroNa origem "funcionario": vai como "estoque_funcionario_id" (o mesmo id de estoque_funcionarios_listar e dos equipamentos do atendimento).
origens[].itens[].quantidadeinteiroItem sem MAC e sem série pode estar somado numa linha. Cada inserção leva UMA unidade; o resto continua com o técnico.
produtos[].onu / .exige_macboolonu = serial de 12 caracteres obrigatório (MAC opcional); exige_mac = MAC obrigatório. Nenhum dos dois = MAC e serial opcionais.
vlans_livres[].porta_ponstring|nullPorta da OLT já ligada à VLAN. null = VLAN ainda sem porta (o NOC associa pela tela).

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
405metodo_invalidoMétodo diferente de GET e POST.
POST /api/v1/predio_equipamento_inserir.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Inserir equipamento no prédio

Coloca um equipamento no prédio e dá a baixa na origem NA MESMA TRANSAÇÃO — ou entra no prédio e sai da origem, ou não acontece nada. "pendencia": finaliza a pendência de vínculo deste prédio. "funcionario": tira o item do estoque do técnico do token (item de outro técnico é recusado). "sem_registro": só cadastra (equipamento que já estava lá).

O produto, o MAC e o serial vêm da origem; o que o app mandar em "mac"/"serial" só completa o que a origem não tinha.

REGRAS: ONU/ONT exige serial de 12 caracteres; produto com MAC obrigatório exige MAC; MAC e serial não podem repetir os de outro equipamento de prédio. Devolve a lista de equipamentos do prédio já atualizada.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
origemstringSimpendencia | funcionario | sem_registro (origens[].origem de predio_equipamento_opcoes).
pendencia_idinteiroSim, na origem pendenciaorigens[].itens[].pendencia_id.
estoque_funcionario_idinteiroSim, na origem funcionarioorigens[].itens[].estoque_funcionario_id — item do estoque do próprio técnico.
produto_idinteiroSim, na origem sem_registroprodutos[].produto_id. Nas outras origens é ignorado: o produto é o do item.
serialstringSim, em ONU/ONT sem serial na origemSerial Number. ONU/ONT: exatamente 12 caracteres (letras e números).
macstringSim, em produto que exige MAC e sem MAC na origem12 hexadecimais, com ou sem separador (AA:BB:CC:DD:EE:FF, AABBCCDDEEFF). É guardado com dois-pontos.
localizacaostringNãoOnde fica no prédio ("Shaft do 3º andar", "Hall de entrada").
observacaostringNãoObservação do equipamento.
vlan_idinteiroNãoSó ONU/ONT: vlans_livres[].vlan_id. A VLAN passa a "em uso" por este prédio.
data_instalacaodataNãoAAAA-MM-DD, não futura. Padrão: hoje.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_equipamento_inserir.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 42,
  "origem": "funcionario",
  "estoque_funcionario_id": 88,
  "localizacao": "Shaft do 3º andar",
  "vlan_id": 41
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Equipamento adicionado: ONU GPON EXEMPLO (SN: EXMP00000001) (MAC: AA:BB:CC:00:00:01).",
    "equipamento_id": 3101,
    "origem": "Estoque do técnico Técnico Exemplo (item #88)",
    "equipamentos": [
      {
        "id": 3101,
        "produto_id": 12,
        "produto": "ONU GPON EXEMPLO",
        "categoria": "ONU",
        "onu": true,
        "mac": "AA:BB:CC:00:00:01",
        "serial": "EXMP00000001",
        "vlan": { "id": 40, "numero": 2001, "descricao": "Vlans para Prédios" },
        "porta_pon": "Fabricante OLT_01 - Slot 1 / Porta 2",
        "localizacao": "Shaft do 3º andar",
        "observacao": null,
        "data_instalacao": "2026-05-10",
        "status": "ativo",
        "status_label": "Ativo"
      }
    ]
  }
}

Campos da resposta

CampoTipoO que é
equipamentos[].idinteiroId do equipamento NO PRÉDIO — é o "equipamento_id" de editar, remover e trocar.
equipamentos[].onubooltrue = ONU/ONT (decidido pela categoria do produto): serial de 12 caracteres obrigatório, e só ela tem VLAN e porta PON.
equipamentos[].mac / .serialstring|nullMAC no formato AA:BB:CC:DD:EE:FF; serial em maiúsculas. null quando o equipamento não tem.
equipamentos[].vlanobjeto|nullVLAN da ONU (id, numero, descricao). null em equipamento que não é ONU ou em ONU sem VLAN definida.
equipamentos[].porta_ponstring|nullPorta da OLT, já em texto. Vem da VLAN: o app não escolhe a porta.
equipamentos[].statusstringativo | inativo | manutencao (status_label traz o texto).

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400origem_invalida"origem" diferente de pendencia, funcionario e sem_registro.
403origem_nao_permitida"estoque" (saída direta do estoque da empresa) não é feita pelo app.
403item_de_outro_tecnicoO estoque_funcionario_id não é do técnico do token.
422operador_sem_funcionarioOrigem "funcionario" e o usuário do token não está vinculado a um funcionário: não há estoque próprio.
422serial_invalidoONU/ONT com serial diferente de 12 caracteres.
422mac_invalido"mac" não tem 12 hexadecimais.
422mac_obrigatorioO produto exige MAC e ele não veio (nem da origem).
404produto_nao_encontradoproduto_id não existe.
404vlan_nao_encontradavlan_id não existe.
409operacao_recusadaMAC ou serial já cadastrado em outro equipamento de prédio; pendência já finalizada ou de outro prédio; item que não está mais no estoque do técnico. erro.mensagem diz qual.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
POST /api/v1/predio_equipamento_editar.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Editar equipamento do prédio

Altera os dados de um equipamento do prédio. CAMPO QUE NÃO VEM FICA COMO ESTÁ; campo que vem vazio é apagado. ONU/ONT: serial (12 caracteres), MAC, localização, observação, VLAN e status. Demais equipamentos: MAC, localização, observação e status (serial e VLAN são ignorados). Trocar a VLAN libera a antiga e ocupa a nova; "vlan_id": null deixa a ONU sem VLAN. O produto não muda — para pôr outro aparelho no lugar, use predio_equipamento_trocar. Cada mudança entra no histórico do prédio.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
equipamento_idinteiroSimequipamentos[].id.
serialstringNãoSó ONU/ONT: 12 caracteres, sem repetir o de outro equipamento.
macstringNão12 hexadecimais; "" apaga. Não pode repetir o de outro equipamento.
localizacaostringNãoOnde fica no prédio; "" apaga.
observacaostringNãoObservação; "" apaga.
vlan_idinteiro|nullNãoSó ONU/ONT: vlans_livres[].vlan_id, ou null para deixar sem VLAN.
statusstringNãoativo | inativo | manutencao.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_equipamento_editar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 42,
  "equipamento_id": 3101,
  "localizacao": "Shaft do 4º andar",
  "status": "manutencao"
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Equipamento atualizado.",
    "equipamento_id": 3101,
    "alteracoes": [
      "Local: Shaft do 3º andar → Shaft do 4º andar",
      "Status: Ativo → Manutenção"
    ],
    "equipamentos": [
      {
        "id": 3101,
        "produto_id": 12,
        "produto": "ONU GPON EXEMPLO",
        "categoria": "ONU",
        "onu": true,
        "mac": "AA:BB:CC:00:00:01",
        "serial": "EXMP00000001",
        "vlan": { "id": 40, "numero": 2001, "descricao": "Vlans para Prédios" },
        "porta_pon": "Fabricante OLT_01 - Slot 1 / Porta 2",
        "localizacao": "Shaft do 3º andar",
        "observacao": null,
        "data_instalacao": "2026-05-10",
        "status": "ativo",
        "status_label": "Ativo"
      }
    ]
  }
}

Campos da resposta

CampoTipoO que é
alteracoes[]lista de stringO que mudou, em texto (é o que vai para o histórico). Lista vazia = os valores enviados eram iguais aos atuais ("msg": "Nada mudou.").
equipamentos[].idinteiroId do equipamento NO PRÉDIO — é o "equipamento_id" de editar, remover e trocar.
equipamentos[].onubooltrue = ONU/ONT (decidido pela categoria do produto): serial de 12 caracteres obrigatório, e só ela tem VLAN e porta PON.
equipamentos[].mac / .serialstring|nullMAC no formato AA:BB:CC:DD:EE:FF; serial em maiúsculas. null quando o equipamento não tem.
equipamentos[].vlanobjeto|nullVLAN da ONU (id, numero, descricao). null em equipamento que não é ONU ou em ONU sem VLAN definida.
equipamentos[].porta_ponstring|nullPorta da OLT, já em texto. Vem da VLAN: o app não escolhe a porta.
equipamentos[].statusstringativo | inativo | manutencao (status_label traz o texto).

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400parametro_ausenteFaltou "equipamento_id", ou não veio nenhum campo para alterar.
400parametro_invalido"status" fora da lista.
404equipamento_nao_encontradoO equipamento não existe neste prédio.
422serial_invalidoONU/ONT com serial diferente de 12 caracteres.
422mac_invalido"mac" não tem 12 hexadecimais.
409serial_repetidoO serial já está em outro equipamento de prédio.
409mac_repetidoO MAC já está em outro equipamento de prédio.
404vlan_nao_encontradavlan_id não existe.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
POST /api/v1/predio_equipamento_remover.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Remover equipamento do prédio

Tira o equipamento do prédio, com o motivo. A VLAN que ele usava volta a ficar livre. O equipamento NÃO volta para o estoque de ninguém: sai do prédio e fica o registro (o que saiu, de onde e por quê) no histórico. Peça confirmação ao técnico antes de chamar — não há como desfazer pelo app.

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
equipamento_idinteiroSimequipamentos[].id.
motivostringSimPor que está saindo (3 a 300 caracteres). Vai para o histórico.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_equipamento_remover.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 42,
  "equipamento_id": 3101,
  "motivo": "Prédio migrado para fibra no apartamento"
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Equipamento removido: ONU GPON EXEMPLO (SN: EXMP00000001) (MAC: AA:BB:CC:00:00:01).",
    "equipamentos": []
  }
}

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400parametro_ausenteFaltou "equipamento_id" ou "motivo".
404equipamento_nao_encontradoO equipamento não existe neste prédio (ou já foi removido).
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.
POST /api/v1/predio_equipamento_trocar.php 🔑 requer chave · predios:gravar 👷 token do técnico ▶ Trocar equipamento do prédio

Sai um equipamento e entra outro,

TUDO OU

NADA: se o que entra for recusado (MAC repetido, item que não está mais no estoque), o que ia sair continua no prédio. O que ENTRA segue as regras e as origens do predio_equipamento_inserir.

HERANÇA: sem "localizacao" e sem "vlan_id", o novo fica no mesmo lugar e na mesma VLAN do que saiu — o caso comum de trocar uma ONU queimada. O que SAI segue a regra do remover: sai do prédio, não volta para estoque. Fica UM registro no histórico ("Equipamento trocado: saiu … → entrou …").

Parâmetros

NomeTipoObrigatórioDescrição
idinteiroSimId do prédio (predios[].id de predios_listar).
equipamento_idinteiroSimequipamentos[].id do equipamento que SAI.
motivostringSimMotivo da troca (3 a 300 caracteres). Vai para o histórico.
origemstringSimDe onde vem o que ENTRA: pendencia | funcionario | sem_registro.
pendencia_idinteiroSim, na origem pendenciaComo no inserir.
estoque_funcionario_idinteiroSim, na origem funcionarioComo no inserir.
produto_idinteiroSim, na origem sem_registroComo no inserir.
serialstringSim, em ONU/ONT sem serial na origemComo no inserir.
macstringSim, em produto que exige MAC e sem MAC na origemComo no inserir.
localizacaostringNãoSem ela, herda a do equipamento que sai.
vlan_idinteiroNãoSó ONU/ONT. Sem ele, herda a VLAN do equipamento que sai.
observacaostringNãoObservação do equipamento que entra.

Exemplo

curl -s -X POST "https://sysimb.imbranet.com.br/api/v1/predio_equipamento_trocar.php" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "X-Tecnico-Token: TOKEN_DO_TECNICO" \
  -H "Content-Type: application/json" \
  -d '{
  "id": 42,
  "equipamento_id": 3100,
  "motivo": "ONU queimada",
  "origem": "funcionario",
  "estoque_funcionario_id": 88
}'

Resposta

{
  "ok": true,
  "data": {
    "msg": "Troca registrada. Saiu: ONU GPON EXEMPLO (SN: EXMP00000009). Entrou: ONU GPON EXEMPLO (SN: EXMP00000001) (MAC: AA:BB:CC:00:00:01).",
    "equipamento_id": 3101,
    "saiu": "ONU GPON EXEMPLO (SN: EXMP00000009)",
    "entrou": "ONU GPON EXEMPLO (SN: EXMP00000001) (MAC: AA:BB:CC:00:00:01)",
    "origem": "Estoque do técnico Técnico Exemplo (item #88)",
    "equipamentos": [
      {
        "id": 3101,
        "produto_id": 12,
        "produto": "ONU GPON EXEMPLO",
        "categoria": "ONU",
        "onu": true,
        "mac": "AA:BB:CC:00:00:01",
        "serial": "EXMP00000001",
        "vlan": { "id": 40, "numero": 2001, "descricao": "Vlans para Prédios" },
        "porta_pon": "Fabricante OLT_01 - Slot 1 / Porta 2",
        "localizacao": "Shaft do 3º andar",
        "observacao": null,
        "data_instalacao": "2026-05-10",
        "status": "ativo",
        "status_label": "Ativo"
      }
    ]
  }
}

Campos da resposta

CampoTipoO que é
equipamento_idinteiroId do equipamento que ENTROU (o que saiu deixa de existir).
equipamentos[].idinteiroId do equipamento NO PRÉDIO — é o "equipamento_id" de editar, remover e trocar.
equipamentos[].onubooltrue = ONU/ONT (decidido pela categoria do produto): serial de 12 caracteres obrigatório, e só ela tem VLAN e porta PON.
equipamentos[].mac / .serialstring|nullMAC no formato AA:BB:CC:DD:EE:FF; serial em maiúsculas. null quando o equipamento não tem.
equipamentos[].vlanobjeto|nullVLAN da ONU (id, numero, descricao). null em equipamento que não é ONU ou em ONU sem VLAN definida.
equipamentos[].porta_ponstring|nullPorta da OLT, já em texto. Vem da VLAN: o app não escolhe a porta.
equipamentos[].statusstringativo | inativo | manutencao (status_label traz o texto).

Erros deste endpoint

HTTPCódigoQuando acontece
401tecnico_sem_tokenFaltou o header X-Tecnico-Token (faça o tecnico_login).
401tecnico_token_invalidoToken desconhecido ou de outra aplicação: entrar de novo.
401tecnico_sessao_expiradaO login expirou ou o técnico saiu: entrar de novo.
403tecnico_sem_permissaoO usuário não tem app_tecnico_predios nem a permissão equivalente da tela de Prédios Fibra. "pode.predios" do tecnico_login / tecnico_sessao já diz isso antes.
400parametro_ausenteFaltou "id" do prédio ou outro parâmetro obrigatório (a mensagem diz qual).
404predio_nao_encontradoNão existe prédio com este id.
400parametro_ausenteFaltou "equipamento_id", "motivo", "origem" ou o identificador da origem.
404equipamento_nao_encontradoO equipamento que sai não existe neste prédio.
403origem_nao_permitida"estoque" (saída direta do estoque da empresa) não é feita pelo app.
403item_de_outro_tecnicoO estoque_funcionario_id não é do técnico do token.
422serial_invalidoONU/ONT com serial diferente de 12 caracteres.
422mac_invalido"mac" não tem 12 hexadecimais.
422mac_obrigatorioO produto exige MAC e ele não veio.
409operacao_recusadaO que entra foi recusado (MAC/serial repetido, pendência de outro prédio, item fora do estoque): NADA mudou — o que ia sair continua no prédio.
405metodo_invalidoMétodo diferente de POST.
409operacao_recusadaA regra recusou: erro.mensagem diz o motivo, pronto para mostrar ao técnico.
500erro_internoFalha ao gravar. Nada foi alterado.

⚠️ Tratamento de erros

Erros seguem o envelope { "ok": false, "erro": { "codigo", "mensagem" } }. Trate pelo código — a mensagem é para leitura humana e pode mudar. Os erros abaixo valem para todos os endpoints; os próprios de cada um estão na seção dele.

Chave da aplicação (todos os endpoints com 🔑)

HTTPCódigoSignificado
401sem_credencialHeader Authorization ausente
401credencial_invalidaChave não existe
403chave_revogadaChave desativada
403chave_expiradaPassou da validade
403ip_nao_autorizadoIP de origem fora da whitelist
403sem_escopoChave não tem o escopo exigido — lembrando que o * não concede os escopos 🔒
429rate_limitExcedeu o limite de requisições/minuto

Token do técnico (endpoints com 👷)

HTTPCódigoSignificado
401tecnico_sem_tokenFaltou o header X-Tecnico-Token — faça o tecnico_login
401tecnico_token_invalidoToken desconhecido ou feito com outra chave — entrar de novo
401tecnico_sessao_expiradaO login expirou (15 dias) ou o técnico saiu — entrar de novo
403tecnico_inativoO usuário foi desativado no SysIMB
403tecnico_sem_permissaoO usuário do técnico não tem a permissão do SysIMB para esta ação

Requisição e servidor

HTTPCódigoSignificado
400json_invalidoEnviou Content-Type: application/json com um corpo que não é JSON válido
405metodo_invalidoMétodo HTTP diferente do indicado no endpoint (ex.: GET num endpoint só POST)
500erro_internoFalha inesperada do nosso lado. Pode tentar de novo; se persistir, avise o suporte com o horário da chamada

🎯 Escopos

Cada chave possui escopos que definem o que ela pode acessar. * concede todos, exceto os marcados com 🔒: esses alteram dados sensíveis e só valem se estiverem marcados na chave, um a um. Para receber um escopo, peça a quem administra a sua chave.

EscopoDescriçãoEndpoints
* Acesso a todos os escopos, atuais e futuros — menos os marcados com 🔒 —
spc:consultar Consultar CPF ou CNPJ no SPC Brasil spc_consultar
cobertura:consultar Validar ponto (GPS/CEP/endereço) nas áreas de cobertura area_validar
predios:consultar Consultar prédios de fibra por endereço predio_consultar
predios:ler App do técnico: consultar o prédio (informações, anotações, equipamentos, clientes e histórico) predios_listar, predio_detalhar, predio_clientes_buscar, predio_equipamento_opcoes
predios:gravar App do técnico: anotar observações técnicas, vincular clientes e inserir/editar/remover/trocar equipamentos do prédio predio_anotacao_inserir, predio_anotacao_editar, predio_anotacao_excluir, predio_clientes_vincular, predio_equipamento_inserir, predio_equipamento_editar, predio_equipamento_remover, predio_equipamento_trocar
setores:listar Listar os setores do sistema setores_listar
operadores:consultar Consultar dados do funcionário pelo login do operador operador_consultar, operadores_buscar
planos:consultar Consultar planos (planos_vigo) pelo ID Vigo plano_consultar
clientes:cadastrar Enviar cadastro de cliente para a fila de pré-cadastro e consultar a situação cadastro_contexto, cliente_pre_cadastrar, cliente_pre_consultar
clientes:documento_ler Ler documento de identidade (RG/CNH) por IA e extrair os dados cliente_documento_ler
endereco:resolver Resolver endereço por CEP, texto ou coordenada endereco_resolver
atendimentos:ler App do técnico: login do técnico e consulta de atendimentos e anexos do Vigo tecnico_login, tecnico_sessao, tecnico_logout, atendimento_opcoes, atendimentos_listar, atendimento_consultar, atendimento_equipamentos, atendimento_total, atendimento_servicos, atendimento_cabos, atendimento_materiais, atendimento_equipamento_troca_opcoes, atendimento_cliente, atendimento_anexo_baixar
atendimentos:gravar App do técnico: abrir, atualizar e encerrar atendimentos e anexar arquivos atendimento_abrir, atendimento_atualizar, atendimento_encerrar, atendimento_equipamento_inserir, atendimento_equipamento_alterar, atendimento_equipamento_remover, atendimento_cobranca_forma, atendimento_cobranca_pix, atendimento_servico_inserir, atendimento_servico_horario, atendimento_servico_remover, atendimento_cabo_remover, atendimento_material_inserir, atendimento_material_remover, atendimento_equipamento_troca_definir, atendimento_pix_gerar, atendimento_pix_enviar, atendimento_anexo_enviar, atendimento_anexo_excluir
estoque:consultar Consultar produto do estoque pelo ID e os equipamentos com funcionários (somente leitura) estoque_produto_consultar, estoque_funcionarios_listar
estoque:ajustar 🔒 Alterar a quantidade em estoque de um produto (ajuste com motivo, registrado no histórico)
Não vem no *: precisa estar marcado na chave.
estoque_ajustar
servicos:consultar App do técnico: consultar a tabela de valores de serviços (somente leitura) servicos_valores_listar, servico_valor_consultar
estoque:bobina_baixar 🔒 App do técnico: baixar os metros usados da bobina de cabo DROP que está com ele
Não vem no *: precisa estar marcado na chave.
estoque_bobina_baixar