Wispro (AR) - pt
Essa documentação trata do serviço externo Wispro. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadas.
Tipo de Integração
A integração OZmap-Wispro é do tipo Ativa.
Descrição
O Wispro é um software desenvolvido para centralizar a administração e a gestão de Provedores de Serviço de Internet (ISP/WISP).
As funcionalidades da integração entre OZmap e Wispro se baseiam na sincronização de clientes e caixas entre os sistemas. A integração encontra os clientes Wispro no OZmap através do seu ID de contrato.
Observação: O ID do contrato Wispro, representado na API pelo atributo “public_id”, deve ser igual ao código do cliente no OZmap para que o cliente seja localizado corretamente. Esse ID de contrato corresponde a um número sequencial do contrato exibido na interface do Wispro. Abaixo, segue uma imagem destacando em vermelho a informação referente a esse ID de contrato:
Resumo das funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Atualização de Dados de Clientes no OZmap | Atualização dos dados dos clientes cadastrados no OZmap, podendo incluir nome, endereço, usuário pppoe, endereço mac, e observações. | Wispro => OZmap |
Atualização das Coordenadas de Clientes | Ao atualizar coordenadas de um cliente no sistema escolhido como fonte, replica essa alteração no sistema oposto. | OZmap => Wispro ou Wispro => OZmap |
Atualização de Caixa do Cliente | Ao trocar um cliente de caixa no sistema escolhido como fonte, replica essa alteração no sistema oposto. | OZmap => Wispro ou Wispro => OZmap |
Criação de Clientes no OZmap | Criação no OZmap de clientes que possuem contrato no Wispro. | Wispro => OZmap |
Cancelamento de Clientes no OZmap | Remoção no OZmap de clientes que não possuem contrato no Wispro. | Wispro => OZmap |
Sincronização de Caixas | Criação, exclusão e atualização de caixas no Wispro, com base nos dados de caixas OZmap. | OZmap => Wispro |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Atualização de dados dos Clientes no OZmap
Após cada intervalo entre as sincronizações, a integração busca os contratos e clientes no Wispro.
Identifica os clientes no OZmap que possuam código semelhante ao ID do contrato existente no Wispro, e atualiza os campos baseados nas seguintes regras:
Nome
Se houver alteração do nome no Wispro e esteja com diferença no OZmap, é considerado o nome que está no Wispro. (Qualquer alteração de nome no OZmap será descartada)
Endereço
Atualização do campo endereço do cliente no OZmap é baseado na leitura informada pelo Wispro. A atualização é feita caso o endereço do Wispro seja diferente do endereço existente no OZmap atualmente.
Usuário pppoe e endereço mac
Atualização do valor do campo de usuário pppoe e endereço mac no OZmap é baseado na leitura informada pelo Wispro. A atualização é feita caso o usuário pppoe ou endereço mac do contrato no Wispro seja diferente do existente no OZmap atualmente.
Observações
A atualização do campo "observações" do cliente no OZmap é feita com base nas informações fornecidas pelo Wispro. Esse processo utiliza os dados disponíveis nos detalhes do contrato do cliente no Wispro para garantir que as informações estejam alinhadas entre os sistemas.
Atualização das Coordenadas do Cliente
A funcionalidade de atualização de coordenadas permite manter os dados de latitude e longitude do cliente sincronizados entre dois sistemas. Essa atualização pode ser configurada para ter como fonte principal o OZmap ou o Wispro.
O processo de atualização ocorre da seguinte forma:
É realizada a leitura de todos os contratos de clientes do Wispro.
A integração busca clientes no OZmap que possuam código semelhante ao ID do contrato no Wispro.
A integração compara os valores de latitude e longitude entre os dois sistemas, utilizando como fonte o sistema determinado pelo cliente.
Caso seja identificada uma divergência entre as coordenadas dos sistemas e:
O sistema fonte para as coordenadas seja o OZmap:
As coordenadas de latitude e longitude do contrato do cliente no Wispro são atualizadas com os valores presentes no OZmap.O sistema fonte para as coordenadas seja o Wispro:
As coordenadas de latitude e longitude da propriedade do cliente no OZmap são atualizadas com os valores presentes no Wispro.
Observação: Caso a configuração “Considerar data de última atualização para atualização de coordenadas” esteja ativa e utilizando o sistema fonte OZmap, a integração buscará atualizar somente os clientes ou contratos que sofreram alterações desde a última sincronização, garantindo maior eficiência no processo e evitando operações desnecessárias.
Atualização da Caixa do Cliente
A atualização da caixa do cliente consiste em identificar que um cliente foi alterado de caixa no sistema escolhido como fonte, e replicar essa atualização para o outro sistema, e ocorre da seguinte forma:
É feito a busca de todos os contratos existentes no Wispro.
A integração busca clientes no OZmap com código igual ao ID de contrato do cliente Wispro.
Caso o sistema escolhido como fonte seja o OZmap:
Caso o cliente no Wispro esteja em uma caixa diferente no OZmap, é atualizado a caixa do contrato do cliente no Wispro, replicando os dados do OZmap.
Caso o cliente não tenha informações de caixa no OZmap e a configuração ‘Desconexão de clientes em trocas de caixa caso não tenham informações de conexão no sistema fonte’ esteja ativa, também faz a desconexão do cliente no Wispro.
IMPORTANTE:
A atualização de caixa será realizada apenas se houver uma caixa no Wispro vinculada à caixa correspondente no OZmap do cliente. Além disso, é importante destacar que a caixa vinculada no Wispro deve estar associada a uma OLT para que a atualização seja efetuada corretamente.
Caso o sistema escolhido como fonte seja o Wispro:
Caso o cliente no OZmap esteja em uma caixa diferente no Wispro, é atualizado a caixa do cliente no OZmap conectando-o na primeira porta livre do primeiro splitter.
Caso o cliente não tenha informações de caixa no Wispro e a configuração ‘Desconexão de clientes em trocas de caixa caso não tenham informações de conexão no sistema fonte’ esteja ativa, também faz a desconexão da fibra do cliente no splitter OZmap mantendo o drop na caixa.
IMPORTANTE:
A atualização de caixa somente será feita caso haja uma caixa no OZmap vinculada com a caixa Wispro do cliente.
Criação de Clientes no OZmap
A criação de clientes consiste em buscar todos os contratos de clientes que existem no Wispro e que não existem no OZmap, e criá-los no OZmap, seguindo a seguinte ordem:
É feito a leitura de todos os contratos de clientes no Wispro;
Para cada contrato de cliente no Wispro, é verificado se existe um cliente OZmap, procurando pelo código do cliente OZmap semelhante ao ID do contrato Wispro.
A integração tentará criar os clientes que existem no Wispro mas não existem no OZmap;
Para cada contrato de cliente no Wispro a ser criado no OZmap, será buscado, pelo id da caixa OZmap, se a caixa do cliente no Wispro está vinculada a uma Caixa no OZmap;
Caso a caixa do cliente no Wispro não esteja vinculada a nennhuma caixa no OZmap o cliente não será criado.
Se for encontrada uma caixa correspondente no OZmap, criamos o imóvel no OZmap conectado a essa caixa e o cliente com o código OZmap sendo o ID de contrato do cliente Wispro.
Caso a caixa exista no OZmap e tenha splitter, criamos o cliente na primeira porta livre do primerio splitter (o splitter deve permitir conexão de cliente).
O cliente será criado com nome, usuário pppoe, endereço mac, endereço, coordenadas e observações provenientes do contrato do cliente Wispro.
Cancelamento de Clientes no OZmap
O cancelamento de clientes Wispro no OZmap ocorre com base nas leituras feitas no Wispro e ocorre nas seguintes situações:
É feito a leitura de todos os contratos de clientes no Wispro.
A partir então dos clientes existentes no OZmap a integração busca um contrato de cliente no Wispro que tenha o ID igual ao código do cliente OZmap.
Caso não seja encontrado nenhum contrato Wispro referente a esse cliente, o cliente será cancelado do OZmap, tendo por padrão o imóvel e drop mantidos no OZmap, com o drop sendo sendo mantido conectado a porta do splitter, mas isso pode ser alterado através das Configurações Específicas OZmap - Clientes, onde é possível:
Manter imóvel e drop no OZmap, desconectado o drop conectado à porta do splitter (para isso, basta que o parâmetro “Desconectar Drop de Clientes cancelados no OZmap“ esteja ativo).
Sincronização de Caixas
A Sincronização de Caixas OZmap se baseia na criação, atualização e exclusão de caixas no Wispro com base nos dados de caixas OZmap, e ocorre da seguinte forma:
A cada ciclo de execução das funcionalidades da integração, são buscadas todas as caixas Wispro, e as caixas OZmap que tiveram algum tipo de atualização desde a última sincronização da integração e as que pertencem a um projeto novo, e, além disso, a caixa OZmap deve possuir um splitter de atendimento.
A integração verifica se há novas caixas OZmap ainda não vinculadas com caixas Wispro e se alguma caixa vinculada anteriormente entre os sistemas foi atualizada ou removida do OZmap, para realizar os devidos tratamentos no Wispro:
Caso hajam novas caixas OZmap, que não estejam com status “Em projeto”, e ainda não vinculadas com caixas Wispro, será feita a seguinte verificação:
Será verificado se há no Wispro alguma caixa correspondente com nome de caixas OZmap, e caso sejam encontradas caixas com nome semelhantes, essas caixas serão vinculadas entre os dois sistemas na integração.
Caso não seja encontrada nenhuma caixa Wispro com o mesmo nome das caixas OZmap, as caixas OZmap serão criadas no Wispro e vinculadas entre os dois sistemas na integração.
Caso esteja sendo utilizado a configuração “Considerar OLT”, será buscado uma OLT no Wispro com IP correspondente ao da OLT OZmap. Caso não esteja ligado a uma OLT no OZmap ou não seja encontrado uma OLT correspondente no Wispro, a caixa será criada no Wispro sem informação de OLT.
Caso alguma das caixas vinculadas anteriormente tenha tido alguma alteração no OZmap, essas modificações serão repassadas para suas caixas correspondentes no Wispro.
Caso alguma das caixas vinculadas anteriormente tenha sido excluída do OZmap, a integração irá remover as caixas correspondentes do Wispro.
Configurações Base
Parâmetro | Descrição | Padrão |
---|---|---|
Tempo entre Sincronizações | Tempo aguardado entre as sincronizações realizadas pela integração. | 15 minutos
|
Configurações Específicas - Clientes
Parâmetro | Descrição | Padrão |
---|---|---|
Criação de Clientes | Clientes que existem no Wispro porém não existem no OZmap serão criados no OZmap caso a caixa do cliente no Wispro esteja vinculada a uma Caixa no OZmap. | Desativado |
Atualização de Caixa do Cliente | Ao trocar um cliente de caixa no sistema escolhido como fonte, replica essa alteração no sistema oposto. | Desativado |
Cancelamento de Clientes | Clientes que existem no OZmap e não possuem um código referente a um contrato de clinete no Wispro serão removidos do OZmap. | Desativado |
Fonte de informações de caixas para sincronização de caixas entre os sistemas OZmap e Wispro | O sistema fonte que contém os dados de caixa corretos e que serão propagados ao sistema oposto. | ozmap |
Atualizar Coordenadas de Clientes | Atualização dos atributos de latitude e longitude de clientes, com base na leitura do sistema escolhido como fonte. | Desativado |
Fonte de coordenadas para sincronização de coordenadas entre os sistemas | O sistema fonte que contém os dados de coordenadas corretos e que serão propagados ao sistema oposto. | ozmap |
Desconexão de clientes em trocas de caixa caso não tenham informações de conexão no sistema fonte | Decide se a desconexão de clientes e também a falta de conexão de clientes no sistema fonte será propagada para o sistema oposto. | Desativado |
Desconectar Drop de Clientes cancelados no OZmap | Quando um cliente for removido do OZmap por não existir um contrato referente a esse clinete no Wispro, o drop do imóvel será desconectado da porta do splitter OZmap. | Desativado |
Considerar data de última atualização para atualização de coordenadas (só pode ser utilizado caso o sistema fonte para atualiazação de coordenadas seja o OZmap) | No processo de atualização de coordenadas, a integração buscará atualizar as coordenadas somente dos clientes ou contratos que sofreram alterações desde a última sincronização. | Desativado |
Configurações Específicas - Caixas
Parâmetro | Descrição | Padrão |
---|---|---|
Considerar OLT | Busca uma OLT Wispro com IP correspondente ao da OLT OZmap. Caso não esteja ligado a uma OLT no OZmap ou não seja encontrado uma OLT correspondente no Wispro, a caixa será criada sem OLT no Wispro. | Desativado |
Dados Acesso
Wispro
Dados de acesso necessários para buscar informações via API no sistema Wispro (estes dados devem ser fornecidos no questionário inicial).
Parâmetro | Descrição | Exemplo |
---|---|---|
URL | Endereço do servidor Wispro. | https://wispro.co/api/v1 |
Token | Token provido pelo cliente para acessar o serviço. | 59123456-2e1d-479a-9b49-5513b2aac54f |
OZmap
Parâmetro | Descrição | Exemplo |
---|---|---|
Token | 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
Para validação e execução da integração no ambiente de produção, é necessário que sejam liberados no servidor Wispro do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
54.207.162.199
Questionário
Pergunta | Resposta | Funcionalidade |
---|---|---|
|
|
|