Ispbox 2

image-20240419-202446.png

Essa documentação trata da integração com o sistema Ispbox 2. A integração é realizada através de chamadas de API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.

Tipo de Integração

A integração OZmap-Ispbox 2 é do tipo Passiva-direta.

Descrição

O Ispbox 2 é um sistema focado na gestão de provedores de internet, incluindo controle de caixa, vendas, clientes, despesas, entre outros.

A integração tem como objetivo a consulta de viabilidade no OZmap para o endereço de clientes interessados em contratação com reserva de porta via Ispbox 2.

Resumo de funcionalidades

Funcionalidade

Descrição

Direção da integração

Funcionalidade

Descrição

Direção da integração

Consulta de Viabilidade com reserva de Porta no OZmap

Consulta de viabilidade de atendimento para clientes, onde também é realizada a reserva de porta para o cliente no OZmap

Ispbox 2 => OZmap

Cancelamento de reservas no OZmap

Remove clientes com reserva de porta no OZmap, de acordo com reservas canceladas no Ispbox 2.

Ispbox 2 => OZmap

Implantação de Clientes no OZmap

Ativa clientes com reserva de porta no OZmap, de acordo com serviços de internet ativados no Ispbox 2.

Ispbox 2 => OZmap

Funcionalidades

Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.

Consulta de Viabilidade com reserva de Porta no OZmap

A Consulta de Viabilidade com reserva de Porta realizada pelo Ispbox 2 no OZmap consiste em verificar a disponibilidade de atendimento para um novo cliente em determinada localidade e reservar uma porta no OZmap para sua instalação posterior, ocorrendo da seguinte forma:

  • Através do menu “Clientes/Viabilidade” da plataforma Ispbox 2, é acionada a opção “Nova viabilidade”.

  • Após preenchimento dos dados do cliente no Ispbox 2, é acionada a opção “Abrir OZmap”.

  • O Ispbox 2 abrirá o OZloc, com o mapa mostrando a posição encontrada para o cliente:

    • As configurações de viabilidade usadas para essa viabilidade no OZloc são as que estiverem definidas nas configurações do OZmap.

    • Caso o usuário tenha preenchido o campo de coordenadas no Ispbox 2, essa informação será usada pelo OZloc como posição para verificar a disponibilidade de caixas.

    • Caso o usuário tenha preenchido somente o endereço no Ispbox 2, o OZloc irá traduzir esse endereço em coordenadas para então verificar a disponibilidade de caixas.

  • Caso hajam caixas com disponibilidade de atendimento no OZmap para essa localização, o OZloc exibirá a lista de caixas com disponibilidade e quantidade de portas livres que possuem.

  • O usuário seleciona a caixa a qual deseja efetuar a reserva, e então o menu de confirmação de reserva é exibido, para confirmação dos dados do cliente.

  • Com a confirmação da reserva, é criado um cliente no OZmap com estado de implantação “Não implantado” (para representar uma reserva de porta), posicionado na mesma localização usada para a viabilidade, e com os dados de nome, código (número da viabilidade) e endereço preenchidos pelo Ispbox 2.

  • Por fim, o Ispbox 2 retorna para sua tela de viabilidade, onde busca e exibe as informações de caixa e porta a qual a reserva do cliente foi efetuada no OZmap.

Cancelamento de reservas no OZmap

O Cancelamento de reservas consiste em remover do OZmap clientes de reserva de porta que não serão mais instalados, e ocorre da seguinte forma:

  • Através do menu “Clientes/Viabilidade” da plataforma Ispbox 2, é localizada a reserva que deve ser cancelado no OZmap.

  • No menu “Opções” da viabilidade em questão, é acionada a opção “Fechar”, onde o usuário deverá preencher algumas informações e depois salvar o fechamento.

    • IMPORTANTE: Para a reserva ser removida do OZmap, o status selecionado no Ispbox 2 deve ser “Sem sinal”.

  • Com isso, o Ispbox 2 busca no OZmap um imóvel que possua ID igual ao do imóvel criado durante o processo de reserva de porta do cliente.

  • Caso o imóvel do cliente seja encontrado no OZmap, o Ispbox 2 irá remover do OZmap o imóvel do cliente por completo.

  • Adicionalmente, o Ispbox 2 remove automaticamente do OZmap uma reserva que tenha atingido um tempo máximo em dias sem ter sido ativada, definido pela configuração “Tempo em dias para cancelar reserva de porta não utilizada na viabilidade”, nas configurações da integração dentro do Ispbox 2. Por padrão, o valor utilizado é 30 dias.

Implantação de Clientes no OZmap

A Implantação de Clientes consiste em implantar no OZmap clientes de reserva de porta que tiveram serviço de internet ativado no Ispbox 2, e ocorre da seguinte forma:

  • Através do menu “Clientes/Viabilidade” da plataforma Ispbox 2, é localizada a reserva que deve ser ativada no OZmap.

  • No menu “Opções” da viabilidade em questão, é acionada a opção “Fechar”, onde o usuário deverá preencher algumas informações e depois salvar o fechamento.

    • IMPORTANTE: Para a reserva ser ativada no OZmap, deve ser utilizado status que permita a geração de cadastro.

  • Ao gerar um cadastro para o cliente, deve-se incluir um serviço de internet para ele, em "Serviços" e depois "Novo Serviço" -> "Internet".

  • Quando o serviço de internet é salvo no cadastro do cliente, o Ispbox 2 busca no OZmap um imóvel que possua ID igual ao do imóvel criado durante o processo de reserva de porta do cliente.

  • Caso o imóvel do cliente seja encontrado no OZmap, o Ispbox 2 irá ativar o cliente no OZmap mudando seu estado de implantação para “implantado”.

Dados Acesso

Dados de acesso necessários para as operações realizadas pelo integrador são:

Saiba mais como configurar esses dados acionando o suporte do Ispbox 2.

OZmap

Parâmetro

Descrição

Exemplo

Parâmetro

Descrição

Exemplo

Url do Servidor

Endereço do OZmap

https://cliente.ozmap.com.br

Porta API

Porta de serviço padrão do OZmap

9994

Porta OZloc

Porta de serviço padrão do OZloc

9443

API Key

Token associado a conta do usuário de integração cadastrado no OZmap. ( O usuário deve ter acesso aos projetos que a integração irá trabalhar (Escolha do usuário). Tutorial de como gerar usuário/chave)

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtb2R1bGUiOiJhcGkiLCJ1c2VyIjoiNWQ5ZjNmYjgyMDAxNDEwMDA2NDdmNzY4IiwiY3JlYXRpb25EYXRlIjoiMjAyMC0wOC0yNFQxNjoxMjoyMS43MTdaIiwiaWF0IjoxNTk6Mjg1NTQxfQ.S215vbHlBLtZSzxmORIc2sH1lEKi5VALKBqZB1VcFCE

Liberação de IPs

Caso o servidor OZmap esteja em ambiente ON-Premisses, é necessário liberar nos firewalls o IP do servidor onde está o Ispbox 2 para acessar as portas 80 e 9994 no ambiente do OZmap.

Caso seu servidor seja hospedado pelo OZmap, essas portas já estarão liberadas para o integrador.

Questionário

Pergunta

Resposta

Pergunta

Resposta