...
Essa documentação trata da integração com o sistema CNT. A integração é realizada atraves através de chamadas de API partindo do Integrador e utilizando a API disponibilizada no serviço de integração pelo OZmap.
Table of Contents | ||||
---|---|---|---|---|
|
Tipo de Integração
A integração OZmap-CNT é do tipo Passiva-indireta.
Descrição
A O CNT é uma empresa de desenvolvimento de softwares web, especializada em aplicações web e mobile focada em empresas de comunicação e telecomunicaçãoum ERP destinado a provedores de internet e telefonia, totalmente baseado na plataforma Web. Dispõe de uma estrutura flexível capaz de integrar com outras aplicações.
A integração com o OZmap se dá por chamadas API em conjunto com processos do CNT mantendo sincronização em relação as funcionalidades descritasse baseia no CNT realizando principalmente viabilidade, reserva de portas, ativação e cancelamento de clientes no OZmap.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Consulta de viabilidade de acordo com endereço enviado pelo clientesimples no OZmap | O CNT envia o endereço do cliente para o OZmap o qual faz a consulta de viabilidade no local enviado, consultando se há viabilidade de atendimento para este local. | OZmap => CNT |
Criação de reservas de porta no OZmap | O CNT cria uma reserva no OZmap através do Loki caso haja viabilidade e for escolhido fazê-lareservas de porta para clientes no OZmap. | CNT => OZmap |
Implantação e Atualização de dados de clientes no OZmap | O CNT atualiza o status dados como nome do cliente e observações, além do estado de implantação de clientes no OZmap, identificando quando os mesmos foram ativados. | CNT => OZmap |
Atualização de dados de clientes no OZmap | O CNT atualiza o nome, observações do cliente e observações da residência do cliente no OZmap | CNT => OZmap |
Cancelamento de clientes no OZmap | O CNT cancela também remove clientes no OZmap que foram cancelados no ERPdo OZmap. | CNT => OZmap |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona a integração.
Consulta de viabilidade
...
simples no OZmap
A consulta de viabilidade de acordo com o endereço enviado pelo cliente é dada simples no OZmap se baseia na consulta direta de um endereço, verificando se possui viabilidade de atendimento antes de prosseguir com o processo de venda, e ocorre da seguinte forma:
O cliente disponibiliza seu endereço ao atendente.
O atendente então, através da tela fornecida pelo OZmap, verifica a viabilidade do endereço.
Após análise positiva desta viabilidade, o atendente pode abrir o Loki para finalizar o processo de viabilidadeUtilizando a interface OZmap específica para essa consulta, deve ser informado o endereço do cliente.
A consulta de viabilidade informará se possui viabilidade ou não (seguindo os parâmetros definidos nas configurações do OZmap) para o endereço informado, e caso possua viabilidade, o processo de venda pode seguir com o processo de reserva de porta via OZloc.
Criação de reservas de porta no OZmap
A criação de reservas de portas no OZmap é dada no OZmap se baseia na criação de um cliente não implantado no OZmap “guardando” a porta para sua futura instalação, e ocorre da seguinte forma:
Após uma consulta de viabilidade com sucesso, é possível escolher um poste ou caixa em que o cliente será alocado
O cliente, que será identificado pelo código de contrato, então será criado como uma reserva na porta escolhida.
Atualização de clientes no OZmap
A atualização de clientes no OZmap é dada da seguinte forma:
Uma chamada API é feita pelo CNT ao OZmap em casos de atualização de: status de implantação, nome, observações do cliente e observações da residência do cliente, atualizando essas informações do cliente no OZmap usando o código de contrato como identificadoriniciar o processo de reserva de porta pelo OZloc.
O OZloc exibe inicialmente o cliente no mapa na posição encontrada pelo Google para o endereço informado. A posição do Cliente no mapa pode ser refinada ao arrastar a posição do Cliente no mapa do OZloc.
Após indicada a posição do cliente no mapa, automaticamente será apresentada a lista de caixas de atendimento com portas disponíveis (seguindo as opções de viabilidade configuradas para o OZloc no OZmap).
A lista indica o nome da caixa, distância em metros, número de portas disponíveis, status de implantação e tipo da caixa. Existe a opção de desenhar o caminho de drop do cliente manualmente pelo botão “Desenhar drop”.
Ao selecionar a caixa na lista de disponibilidade, um menu para confirmação é exibido, e após ser confirmada a reserva, um cliente será criado no OZmap com o drop conectado a caixa selecionada no OZmap, com estado de implantação “não implantado” e tendo como código no OZmap o código de contrato CNT, código esse pelo qual o cliente é identificado entre os dois sistemas nas demais ações da integração.
Implantação e Atualização de dados de clientes no OZmap
A implantação e atualização de clientes no OZmap ocorre da seguinte forma:
O CNT encontra os clientes para atualizar buscando no OZmap um cliente que possua o código igual ao código de contrato do cliente no CNT.
Quando um cliente é ativado no CNT, o CNT atualiza no OZmap o estado de implantação do cliente correspondente para “implantado”.
A CNT atualiza também, de acordo com as suas configurações, o nome do cliente e as suas observações no OZmap.
Cancelamento de clientes no OZmap
O cancelamento de clientes no OZmap é dado consiste no CNT remover clientes que foram cancelados do OZmap, e ocorre da seguinte forma:
Uma chamada API é feita pelo CNT ao OZmap quando um cliente é cancelado, removendo o cliente da propriedade e deixando o drop e propriedade conectados à porta escolhida, com possibilidade de configuração para desconectá-los da porta caso seja necessárioO CNT encontra os clientes para cancelar buscando no OZmap um cliente que possua o código igual ao código de contrato do cliente cancelado no CNT.
Existem dois tipos de remoção de clientes feitas pelo CNT no OZmap:
Cancelamento: Quando o contrato de um cliente já ativo é cancelado no CNT, o CNT remove o cliente cancelado do OZmap, mantendo apenas o seu imóvel com o seu código nas observações e o drop permanece conectado ao splitter OZmap. Nessas situações, também é possível configurar a integração para desconectar o drop do cliente da porta do splitter.
Desistência: Quando houve uma reserva de porta para um cliente mas o mesmo cancelou antes da ativação, o CNT remove completamente o cliente do OZmap (cliente, imóvel e drop são excluídos).
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 CNT.
OZmap
Parâmetro | Descrição | Exemplo |
---|---|---|
URL | Endereço do OZmap, com a porta de serviço padrão.serviço de integração no OZmap | https://cliente.ozmap.com.br:9994/apiintegrations/v2cnt |
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
Caso o servidor OZmap esteja em ambiente ON-Premisses, é necessário liberar nos firewalls o IP do servidor onde está o CNT para acessar as portas 80 e 9994 14000 no ambiente do OZmap.
Caso seu servidor seja hospedado pelo OZmap, essas portas já estarão liberadas para o integrador.
Questionário
Pergunta | Resposta |
---|---|
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.