MSN Web [WiP]

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

Tipo de Integração

A integração OZmap-MSN Web é do tipo Passiva-Direta.

Descrição

O MSN Web é uma agência especializada em soluções digitais, seja em um e-commerce (loja virtual), um site institucional, ou algo mais específico como uma integração com outros sistemas ERP, CRM ou até mesmo Gateways de pagamento e API.

A integração tem como objetivo a consulta de viabilidade e criação de leads no OZmap quando não ocorre viabilidade em um endereço.

Resumo de funcionalidades

Funcionalidade	Descrição	Direção da integração
Consultar Caixas OZmap Disponíveis para Viabilidade	O MSN Web realiza a busca de caixas OZmap próximas do endereço do cliente disponíveis para conexões. Essa viabilidade pode ser realizada por raio ou por postes.	OZmap => MSN Web
Criação de LEADs como Prospects OZmap	O MSN Web realiza a criação de leads como prospects no OZmap quando não houver viabilidade para um endereço.	MSN Web => OZmap

Funcionalidades

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

Consultar Caixas OZmap Disponíveis para Viabilidade

A consulta das Caixas disponíveis no OZmap para verificação de viabilidade é feita na página do cliente chamada "Disponibilidade" e pode ser realizada de duas maneiras:

Consulta de viabilidade via endereço:
- Ao inserir e confirmar o endereço, o MSN Web realiza a verificação de viabilidade no OZmap, buscando por Caixas que não estejam com o status "Em projeto" e que possuam Splitters com portas disponíveis para atendimento.
- O tipo de viabilidade que será feita no OZmap é por raio, que a partir da coordenada passada pelo MSN Web, busca as caixas mais próximas no OZmap considerando a distância em linha reta do cliente até a caixa.
- Se houver viabilidade no endereço consultado, uma mensagem é exibida na tela do cliente, ou ele é redirecionado para uma página específica, como um formulário de interesse, por exemplo.
Consulta de viabilidade via Google Maps:
- Nesta página chamada de “Disponibilidade”, o Google Maps também pode ser exibido, permitindo que o cliente mova o marcador e selecione o endereço desejado no mapa para a verificação de viabilidade. A partir do endereço escolhido, as coordenadas são obtidas.
- A partir dessas coordenadas é realizada a consulta da viabilidade no OZmap, buscando se naquele endereço e raio pre-definido, existe uma Caixa disponível.

Criação de LEADs como Prospects OZmap

A criação de LEADs no OZmap, é dada da seguinte forma:

No momento da viabilidade realizada através do Google Maps, caso o endereço do cliente não possuir viabilidade no OZmap, um LEAD é criado no painel do cliente no MSN Web e um prospect correspondente é criado no OZmap, de modo a posteriormente realizar essa possível venda novamente;
O prospect criado no OZmap possui as informações de nome completo, endereço, observação e as coordenadas do cliente;

Dados Acesso

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

OZmap

Parâmetro	Descrição	Exemplo
URL	Endereço do OZmap, com a porta de serviço padrão.	https://cliente.ozmap.com.br:9994/api/v2
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 MSN Web 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 MSN Web.

Questionário

Pergunta	Resposta