ZapyHub
Entrar

Documentação

Como o ZapyHub funciona

Escrevemos esta página para quem vai operar o sistema: o dono do provedor e a equipe de TI e redes. Ela cobre o que cada área faz, o que o sistema exige da sua infraestrutura e — com a mesma clareza — o que depende de uma credencial que só você pode providenciar.

Se você está avaliando o ZapyHub, comece pela seção o que já funciona. É a mais honesta, e a que evita surpresa depois de assinar.

Ir para uma seção

Por onde começar

A implantação tem uma ordem, e ela importa: cada etapa usa o que a anterior cadastrou. Um provedor médio percorre isso em uma a duas semanas, e a única parte que depende da sua equipe de redes é a etapa 4.

  1. Nós criamos o seu provedor

    Você recebe um endereço próprio — suaempresa.zapyhub.com — e o primeiro usuário administrador. A partir daí o sistema é seu: cor, logotipo e nome saem do que você cadastrar em Configurações.

  2. Você cadastra os planos

    Velocidade de download e upload, valor, dia de vencimento e o perfil de rede correspondente. É o que amarra o contrato do cliente à configuração que o concentrador vai aplicar.

  3. Traz a base de clientes

    Por planilha, em Clientes → Importar, ou pela migração assistida se você vem de outro sistema. Nos dois casos o sistema confere antes de gravar e mostra o que não bateu, em vez de aceitar tudo e você descobrir no primeiro faturamento.

  4. A sua equipe liga o agente de rede

    Um programa pequeno que roda dentro da sua rede e conversa com a OLT, o MikroTik e o RADIUS. É a única etapa técnica, e leva poucos minutos. A seção Rede explica em detalhe.

  5. Gera o primeiro faturamento

    O sistema monta as faturas do ciclo, emite boleto e Pix, e a régua de cobrança passa a rodar. Confira esse primeiro lote com calma: é nele que aparecem os cadastros que vieram tortos da base antiga.

  6. Abre a Central do Assinante

    Seus clientes passam a ver fatura, segunda via, Pix, chamados e teste de velocidade sem ligar para o atendimento. Com a sua marca, no seu endereço.

  7. Liga o fiscal quando o certificado estiver pronto

    Cálculo, XML e DANFE funcionam desde o primeiro dia. A transmissão à SEFAZ espera o certificado A1 e o credenciamento da sua UF — a seção Nota fiscal lista o que é preciso.

As cinco telas, e quem usa cada uma

O ZapyHub não é uma tela só. São cinco, cada uma pensada para uma pessoa diferente. Vale saber qual é qual antes de distribuir acesso para a equipe.

O ERP
O sistema que a sua equipe usa o dia inteiro: cadastro, financeiro, fiscal, rede, atendimento, estoque e CRM. Abre no seu endereço, suaempresa.zapyhub.com.
A Central do Assinante
O portal do seu cliente final. Fatura, segunda via, Pix, chamados, teste de velocidade e aviso de manutenção — com a sua marca, não com a nossa.
O app de campo
Para o técnico na rua. Instala no celular como aplicativo, funciona sem sinal nenhum e sincroniza quando a conexão volta.
O site público
A sua vitrine e esta documentação. É a única parte que continua no ar mesmo se o banco estiver fora.
O Painel da Plataforma
Nosso, não seu. É onde a equipe ZapyHub acompanha a saúde do serviço. Mencionamos só para você saber que ele existe e que o acesso dele é separado do seu — ninguém da nossa equipe entra no seu ERP sem deixar registro.

Clientes, planos e contratos

É a base do resto. Um cliente tem dados cadastrais e endereço. Um contrato amarra esse cliente a um plano, com vencimento, fidelidade e ponto de instalação.

A distinção importa no dia a dia: o faturamento, a rede e a ordem de serviço olham para o contrato, não para o cliente. É o contrato que diz qual velocidade entregar e quanto cobrar. Por isso um mesmo cliente pode ter dois contratos — matriz e filial, ou dois pontos no mesmo endereço — e cada um suspende, reativa e cancela sozinho, sem mexer no outro.

Pessoa física e jurídica convivem no mesmo cadastro. CPF e CNPJ são validados na digitação, inclusive o CNPJ alfanumérico que passa a valer em 2026.

Faturamento e cobrança

O faturamento roda por ciclo: o sistema varre os contratos ativos, monta as faturas do período e emite os documentos de pagamento. Você revisa o lote antes de liberar.

Boleto
Arquivo CNAB 240 para o seu banco, com código de barras e linha digitável. Funciona desde o primeiro dia, sem integração nenhuma.
Pix
QR Code e copia-e-cola gerados aqui, pagáveis em qualquer banco. A baixa automática por API depende da credencial do seu PSP; sem ela, a baixa vem da conciliação ou é manual.
Conciliação
Você sobe o extrato OFX do banco e o sistema casa os pagamentos com as faturas, apontando o que não bateu em vez de conciliar na marra.
Régua de cobrança
A sequência de avisos e ações para quem atrasa, incluindo redução de velocidade e bloqueio na rede quando o agente está ligado.
Contas a pagar e DRE
O outro lado do caixa, para você enxergar o resultado do mês sem exportar para planilha.
Negativação em lote
Monta a tabela de devedores no formato que o birô exige, confere linha por linha e entrega o arquivo pronto. O envio ao SPC e ao Serasa é feito por você, no site do birô — nós não mandamos nada.
Na negativação, o sistema recusa a linha com cadastro incompleto em vez de exportá-la torta, e diz o que falta em cada uma. O motivo é direto: o birô recusa o arquivo inteiro, não a linha — e uma linha com o documento errado nega crédito a um estranho.
Quando um canal da régua não está configurado, o sistema registra a etapa como não executada, com o motivo, e diz na tela que o cliente não foi avisado. Ele nunca marca como enviado algo que não saiu.

Nota fiscal e obrigações

O módulo cobre NFCom — o modelo 62, que substituiu a nota de telecomunicação —, NFS-e para os serviços que não são comunicação, e os relatórios da Anatel. Tem também um painel de rejeições que traduz o código da SEFAZ para português e diz o que fazer com ele.

Cálculo, XML, assinatura digital e DANFE funcionam desde o primeiro dia. O que depende de você é a transmissão:

  1. Certificado digital A1

    Da cadeia ICP-Brasil, com o CNPJ do provedor. O upload confere e recusa certificado de outro CNPJ.

  2. Credenciamento na SEFAZ da sua UF

    Para NFCom especificamente — é separado do credenciamento de NFe, e muita gente descobre isso tarde. A consulta pública do CCC mostra o que o seu CNPJ já pode emitir em cada estado.

  3. Homologação aprovada

    Emitir no ambiente de teste da SEFAZ até passar limpo. O sistema tem um modo de ensaio que devolve rejeições de propósito, porque ensaio em que tudo autoriza não prepara ninguém para o primeiro mês de verdade.

  4. Alíquotas confirmadas pelo seu contador

    Nós não arbitramos tributo. A tela de regras fiscais é dele, e existe uma visão separada para ele acompanhar sem mexer no resto do sistema.

Enquanto a transmissão estiver desligada, toda tentativa responde que ela está desligada e diz o que falta. Em nenhuma hipótese uma nota aparece como autorizada sem a SEFAZ ter autorizado.

Rede e o agente

Esta é a seção da sua equipe de redes, e o ponto em que o ZapyHub é diferente de um sistema instalado no seu servidor.

O problema: a sua OLT, o seu concentrador e o seu RADIUS estão dentro da sua rede, atrás de NAT e firewall. Um sistema em nuvem não alcança nenhum deles. A saída comum é abrir porta e expor equipamento à internet — e é assim que provedor aparece em notícia.

A nossa solução: um agente. É um programa pequeno que você instala dentro da sua rede, perto dos equipamentos. Ele abre a conexão de dentro para fora, e é por esse túnel que os comandos chegam.

Você não abre porta nenhuma
O túnel parte da sua rede. Do lado de fora não existe nada para alguém encontrar varrendo a internet.
Nenhum equipamento fica exposto
A OLT e o MikroTik continuam sem IP público e sem acesso externo. Quem fala com eles é o agente, de dentro.
Não precisa de IP fixo
O agente reconecta sozinho quando o link cai ou o IP muda.
O pareamento é uma vez só
Você gera um código no ERP e informa ao agente. A credencial de longo prazo é gerada a partir disso e girada automaticamente depois — e a rotação foi feita para não trancar o agente para fora se a troca cair no meio.

Com o agente pareado, o sistema passa a conseguir:

Provisionar ONU
Autorizar, remover e reiniciar a ONU na OLT, a partir da ordem de serviço ou da tela de rede.
Ler potência óptica
Por SNMP ou CLI, direto na tela do cliente — o atendente vê o sinal antes de abrir visita técnica.
Aplicar velocidade e bloqueio
Queue, firewall e walled garden no MikroTik. O bloqueio tem três níveis, do aviso ao corte, e é o que a régua de cobrança aciona.
Sincronizar o RADIUS
Usuários e perfis, para a autenticação continuar sendo sua.
Derrubar sessão
CoA e Disconnect, para a mudança de plano valer na hora em vez de na próxima reconexão.
Sem agente pareado, nenhuma dessas operações finge ter funcionado. Elas respondem que o recurso está indisponível e dizem o próximo passo, e um bloqueio fica pendente — nunca aplicado.

Equipamento compatível

A pergunta que todo provedor faz primeiro, respondida sem rodeio. Onde dizemos que não atende, a tela também diz — o sistema recusa com o motivo em vez de tentar e falhar.

EquipamentoO que o ZapyHub faz
OLT HuaweiProvisionamento de ONU e leitura de potência óptica.
OLT ZTEProvisionamento de ONU e leitura de potência óptica.
Outras OLTsCadastro e inventário funcionam. Provisionamento automático, não — a tela recusa e diz por quê.
MikroTik (RouterOS)Queue, firewall, walled garden e derrubada de sessão.
Outros concentradoresO RADIUS funciona normalmente. A aplicação de velocidade e bloqueio por API, não.
RADIUSSincronização de usuários e perfis, mais CoA e Disconnect.
Um ponto de honestidade: o código fala o protocolo real desses equipamentos e foi verificado contra simulação, não contra uma OLT física no nosso laboratório. Por isso a primeira etapa da implantação é homologar na sua rede, com a sua equipe e a nossa juntas. É o que faríamos de qualquer jeito: cada provedor tem sua versão de firmware e sua topologia.

Atendimento e ordens de serviço

Os chamados têm SLA, fila e histórico. Quando o atendente abre um chamado de conexão, o sistema já consulta a rede e anexa o diagnóstico — sinal da ONU, estado da sessão, situação financeira do contrato — antes de a pessoa perguntar qualquer coisa.

A ordem de serviço é o outro lado: instalação, visita técnica, retirada. Tem agenda, mapa com os pontos do dia e distribuição por técnico. Quando a OS de instalação é concluída, a ativação do contrato na rede dispara sozinha.

Há ainda uma base de conhecimento para a equipe, modelos de resposta e um mural de avisos que aparece na Central do Assinante — útil quando uma manutenção programada vai derrubar um bairro e você quer evitar duzentas ligações.

O app de campo

O técnico vê as ordens do dia, navega até o endereço, registra o que fez, tira foto, colhe assinatura e fecha a OS.

Onde se baixa: em lugar nenhum. Ele não está na Play Store nem na App Store. O técnico abre suaempresa.zapyhub.com/campo no navegador do celular e instala pela tela do próprio navegador:

Android, no Chrome
Aparece um convite para instalar, ou pelo menu de três pontos → Instalar aplicativo.
iPhone, no Safari
Botão Compartilhar → Adicionar à Tela de Início. O iPhone nunca oferece sozinho, então vale avisar a equipe.

Instalado, ele fica na tela inicial com o nome, a cor e o ícone do seu provedor — a palavra ZapyHub não aparece para o seu técnico. Abre em tela cheia, sem barra de endereço, como qualquer aplicativo. E o atalho cobre só o app de campo: ele não captura o ERP nem a Central.

Fizemos assim, e não como app de loja, por três razões práticas. O white-label exigiria publicar um aplicativo por provedor. Toda correção esperaria a revisão da Apple e do Google. E o técnico teria de atualizar — do jeito atual, a correção que entra de manhã está no celular dele à tarde, sem ele fazer nada.

O ponto principal: funciona sem sinal. Em prédio, em zona rural, no subsolo — o técnico continua trabalhando, e tudo o que ele registrou sobe sozinho quando a conexão volta. Não é um aviso de “sem conexão”: é o trabalho inteiro no modo avião.

Isso foi verificado desligando a rede de verdade no meio do fluxo, não só no papel.

A Central do Assinante

O portal do seu cliente final, com a sua marca e no seu endereço. Ele entra e resolve sozinho o que hoje vira ligação para o seu atendimento:

Faturas
Ver, baixar segunda via, copiar o Pix e pagar.
Chamados
Abrir, acompanhar e responder sem telefonar.
Conexão
Teste de velocidade e situação do serviço dele.
Avisos
Manutenção programada e interrupção na região.
Dados
Atualizar cadastro e ver o plano contratado.

O acesso do assinante é separado do acesso da sua equipe. Um cliente da Central nunca enxerga o ERP, e o que ele pode ver é só o que é dele.

Estoque e CRM

Estoque controla o material que passa pela mão dos técnicos: produtos, números de série, depósitos, CTOs, kits de instalação, entradas, compras, inventário e perdas. Quem rastreia ONU por serial sabe por que isso importa — é a diferença entre saber onde está o equipamento e descobrir no inventário anual que sumiram quarenta.

CRM cuida da venda antes de virar contrato: leads, funil, propostas, vendedores, comissões e indicação. Tem consulta de viabilidade, para o vendedor responder na hora se o endereço é atendido, e aceite digital — o cliente assina a proposta por link, com validade jurídica, e o contrato nasce daí sem redigitação.

Relatórios e automações

Os relatórios cobrem o que você precisa olhar todo mês — inadimplência, churn, crescimento da base, resultado — e podem ser agendados para chegar por e-mail sem ninguém lembrar de gerar.

As automações são regras que você escreve: quando tal coisa acontecer, faça tal outra. Contrato que entra em atraso de quinze dias, chamado que estoura o SLA, cliente que cancela — cada um pode disparar uma ação. É onde se encaixa boa parte do trabalho repetitivo que hoje alguém faz à mão.

O que já funciona e o que precisa da sua credencial

Esta é a tabela que pedimos para você ler antes de assinar. A regra que seguimos: nasce ligado o que funciona sozinho, dentro do sistema. Nasce desligado o que depende de um terceiro responder — porque esse terceiro é contrato seu, não nosso.

E o mais importante: nada é simulado. O que está desligado diz que está desligado e explica o que falta. Nenhuma tela mostra sucesso que não aconteceu.

RecursoEstadoO que falta
Boleto CNAB 240Funciona—
Pix: QR Code e copia-e-colaFunciona—
Conciliação por extrato OFXFunciona—
Cálculo fiscal, XML, assinatura e DANFEFunciona—
Agente de rede: OLT, MikroTik, RADIUS, CoAFunciona—
Bloqueio e liberação na redeFunciona—
Notificação no app de campoFunciona—
Baixa automática de Pix por APIDesligadoCredencial do seu PSP
Gateway de pagamento (Asaas)DesligadoConta e credencial no gateway
WhatsApp oficial no atendimentoDesligadoConta Meta Business, número verificado e templates aprovados
Transmissão de NFCom à SEFAZDesligadoCertificado A1 e credenciamento na sua UF
NFS-e municipal e nacionalDesligadoCredenciamento no município ou no ADN
Lote de negativação para SPC e SerasaFuncionaO arquivo é montado aqui; o envio é feito por você

Tudo o que está desligado se liga em Configurações → Integrações, e só depois que a credencial passa no teste. Uma chave não verificada não participa de cobrança.

Segurança e isolamento

Se você está avaliando hospedar a operação fora de casa, estas são as perguntas certas a fazer, e as nossas respostas.

Os dados de um provedor não encostam nos de outro
O isolamento é feito em cinco camadas, incluindo no próprio banco de dados: mesmo uma consulta escrita errada não alcança a base de outro provedor. Isso é testado automaticamente, varrendo todas as tabelas, a cada alteração.
O agente só obedece a quem o pareou
Um comando do provedor A não chega ao agente do provedor B — e isso vale em três níveis, do protocolo ao banco.
Acesso da nossa equipe é registrado e temporário
Se precisarmos entrar no seu ERP para dar suporte, aparece uma faixa permanente na tela avisando, o acesso fica no log e expira sozinho.
Segundo fator obrigatório onde importa
Financeiro, fiscal, integrações e pareamento de agente exigem segundo fator. Não há como desligar essa exigência.
Credenciais de integração são cifradas
As chaves que você cadastra não ficam legíveis no banco.
Trilha de auditoria
Quem fez o quê e quando, em tela própria, incluindo o que foi alterado.

Vindo de outro sistema

A maioria dos nossos clientes vem de HubSoft, IXC, SGP, MK-Auth ou MikWeb. A migração é assistida e tem uma tela própria, com conferência antes de gravar.

O que ela faz diferente de uma importação comum: mostra o que não bateu antes de você confirmar. Cliente sem CPF válido, contrato sem plano correspondente, fatura com valor que não fecha — tudo aparece em lista, você decide o que fazer, e só então grava.

A recomendação que damos a todo mundo: migre, confira o primeiro faturamento em paralelo com o sistema antigo, e só depois desligue o outro. Um mês de sobreposição custa menos que uma fatura errada para a base inteira.

API e webhooks

Se a sua equipe de TI quer integrar o ZapyHub com algo que já existe aí — um painel próprio, um sistema de BI, um bot — há uma API pública com chave por provedor, configurável em Configurações → API.

E há webhooks no caminho inverso: o ZapyHub avisa o seu sistema quando algo acontece aqui — fatura paga, contrato suspenso, OS concluída — sem a sua ponta precisar ficar perguntando.

Perguntas frequentes

Preciso de servidor próprio?

Não para o sistema. O ZapyHub roda na nuvem e você acessa pelo navegador. O que fica na sua rede é o agente, e ele cabe em qualquer máquina pequena que já exista aí — não precisa de hardware novo.

Se a minha internet cair, meus clientes ficam sem internet?

Não. A sua rede continua entregando conexão normalmente — quem autentica é o seu RADIUS, dentro da sua casa. O que para enquanto o link está fora são os comandos novos vindos do sistema, que voltam a ser aplicados quando a conexão retorna.

Todos os módulos entram em todos os planos?

Sim. O que muda entre os planos é o tamanho da base, não a funcionalidade. Provedor pequeno emite nota igual ao grande, porque a obrigação legal é a mesma.

Consigo usar a minha marca?

Sim, na Central do Assinante e no ERP: cor, nome e logotipo saem do que você cadastrar. O seu cliente final não vê o nome ZapyHub.

Quanto tempo leva para implantar?

Uma a duas semanas para a operação do dia a dia. O fiscal costuma levar mais, e o que manda o prazo não somos nós: é o credenciamento na SEFAZ e a homologação.

E se eu quiser sair?

Os seus dados são seus. Há exportação em Configurações → Dados, e nós ajudamos na saída do mesmo jeito que ajudamos na entrada.

Ficou alguma pergunta que esta página não responde? Escreva para [email protected]. Se a pergunta foi sua, provavelmente é de mais gente, e ela vira seção aqui.