Essa documentação trata da integração com o sistema CNT. A integração é realizada atraves de chamadas de API partindo do Integrador e utilizando a API disponibilizada no serviço de integração pelo OZmap.
Tipo de Integração
A integração OZmap-CNT é do tipo Passiva-indireta.
Descrição
A CNT é um ERP destinado à 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 se 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 simples no OZmap | O CNT envia o endereço do cliente para o OZmap, consultando se há viabilidade de atendimento para este local. | OZmap => CNT |
Criação de reservas de porta no OZmap | O CNT cria reservas de porta para clientes no OZmap. | CNT => OZmap |
Implantação e Atualização de dados de clientes no OZmap | O CNT atualiza o estado de implantação de clientes no OZmap, identificando quando os mesmos foram ativados, aleḿ de outros dados, como nome e observações. | CNT => OZmap |
Cancelamento de clientes no OZmap | O CNT remove clientes que foram cancelados do 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 simples no OZmap se baseia na consulta direta de um endereço, verificando se possui viabildiade antes de prosseguir com o processo de venda, e ocorre da seguinte forma:
Utilizando a interface OZmap específica para essa consulta, deve ser informado o endereço do cliente.
A consulta de viabildiade 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 para a reserva de porta via LOKI.
Criação de reservas de porta no OZmap
A criação de reservas de portas no OZmap é dada 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 identificador
Cancelamento de clientes no OZmap
O cancelamento de clientes no OZmap é dado 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ário.
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 serviço de integração no OZmap | |
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 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.
Add Comment