Essa documentação trata do serviço externo Gerenet. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como as funcionalidades relacionadas.
Tipo de Integração
A integração OZmap-Gerenet é do tipo Ativa.
Descrição
O Gerenet é uma ferramenta de gerenciamento da rede integrado ao atendimento aos assinantes.
A integração entre OZmap e Gerenet funciona por dentro do Loki (módulo de viabilidade do OZmap). Seu objetivo principal é, após a viabilidade e reserva de porta, a criação do cliente correspondente a essa reserva no OZmap e Gerenet.
Dados Acesso
Não possui questionário.
Gerenet
Dados de acesso necessários para buscar informações via API no sistema Gerenet. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
|---|---|---|
URL | URL do servidor que contém o serviço externo para conexão. | |
Token | Token provido pelo cliente para acessar o serviço. | qB2M5ZvGmrTBBDOwJgesyqdrsUQaaX |
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 do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
Logs
Os logs desta integração estão disponíveis no endereço: https://<cliente>.ozmap.com.br/integrations/gerenet/logs.
Resumo das funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Atualização de Dados de Equipamento dos Clientes | Atualização da porta de splitter e ponto de acesso do cliente no Gerenet. | Loki => Gerenet |
Criação de Clientes | Criação no Gerenet e OZmap de novos clientes após viabilidade e reserva de porta feita pelo Loki. | Gerenet <= Loki => OZmap |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo para entender como funciona o fluxo.
Criação de Clientes
É feito a viabilidade por clique no mapa ou busca de endereço, no Loki;
Após selecionar a caixa disponível no OZmap para criar o cliente, são buscados os planos no Gerenet;
Selecionado o plano e preenchido os campos de dados do cliente (na tela de venda), é buscado o cliente pelo CPF no Gerenet;
Se o cliente não existir no Gerenet, ele é criado;
Após realizar a consulta de cliente pelo CPF, é criado um ponto no Gerenet sendo retornado para o OZmap o id do cliente e o id do ponto, criados no Gerenet;
Cliente é criado no OZmap com o código OZmap sendo o id do cliente Gerenet + id do ponto (Ex. 3333-15), referentes a criação no Gerenet;
Com o cliente OZmap criado com sucesso, ele é conectado a uma porta de um splitter de caixa selecionada na viabilidade, automaticamente;
Após realizar a conexão do cliente no OZmap, os dados da conexão são retornados para o Gerenet;
Utilizando as informações retornadas do OZmap, é atualizado as informações de caixa, splitter e porta no Gerenet;
Atualização de Dados de Equipamento dos Clientes
É informado, via Gerenet, a nova caixa, splitter, porta e ponto de acesso do cliente Gerenet;
Equipamento do cliente Gerenet é atualizado com as novas informações de caixa, splitter e porta;
Após atualização dos dados do equipamento, o ponto de acesso do cliente também é atualizado no Gerenet;
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Não, atualmente não é possível escolher apenas uma das funcionalidades. | - |
Add Comment