OZneutral

OZneutral-Site-1.png

Essa documentação trata da integração com o OZneutral. A integração é realizada através de chamadas 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-OZneutral é do tipo Passiva-indireta.

Descrição

O OZneutral é uma plataforma responsável por gerenciar a parceria de rede neutras entre clientes e provedores e facilitar a manutenção, cobrança e suporte para parceiro e operadora.

A integração se baseia no OZneutral realizando principalmente viabilidade, reserva de portas, ativação e cancelamento de clientes no OZmap.

No OZneutral, o principal elemento é uma ordem, essa ordem determina o uso de uma porta e indica se a porta está atualmente em uso por algum cliente.

Resumo de funcionalidades

  • Integração Padrão

Funcionalidade

Descrição

Direção da integração

Funcionalidade

Descrição

Direção da integração

Consulta de Viabilidade e Reserva de Portas no OZmap

Buscar viabilidade técnica no OZloc para um endereço de ordem OZneutral e reservar uma porta no OZmap para sua instalação.

OZneutral => OZmap

Registrar Clientes cancelados no OZmap

Destaca com uma tag clientes no OZmap que tiveram suas ordens canceladas no OZneutral.

OZneutral => OZmap

Informação de Caixas e conexões no OZneutral

Busca dados de caixa, splitter e porta do cliente no OZmap para exibir na lista de ordens do OZneutral.

OZmap => OZneutral

  • Integração Customizada

Funcionalidade

Descrição

Direção da integração

Funcionalidade

Descrição

Direção da integração

Cancelamento de Clientes OZmap

Remove clientes no OZmap com base nos dados de ordens canceladas no OZneutral.

OZneutral => OZmap

Implantação de Clientes OZmap

Atualiza o status de implantação do cliente no OZmap com base na ativação de ordens no OZneutral.

OZneutral => OZmap

Atualização de dados de Ordem no OZneutral

Atualiza as ordens no OZneutral com base nos dados do cliente no OZmap.

OZmap => OZneutral

Funcionalidades

Abaixo serão descritas as funcionalidades das duas integrações apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.

Integração Padrão

Consulta de viabilidade e reserva de portas no OZmap

A integração realiza a viabilidade e reserva de portas de clientes OZmap com base nos dados do lead e de ordem no OZneutral, ocorrendo da seguinte forma:

  • Primeiramente é checada a viabilidade do cliente no OZmap, através da criação de um lead no OZneutral que é criado a partir das informações de endereço do cliente.

  • O processo de viabilidade e reserva de porta é realizado pelo OZloc, que exibe inicialmente o cliente no mapa na posição encontrada através da tradução do endereço textual em coordenadas passadas pelo OZneutral. A posição do Cliente no mapa não pode ser alterada.

  • Caso haja a viabilidade, por padrão será automaticamente apresentada a caixa de atendimento mais próxima com portas disponíveis (seguindo as opções de viabilidade configuradas para o OZloc no OZmap).

    • O cliente ainda pode optar por configuração do OZneutral para que a viabilidade considere apenas caixas com tags específicas no OZmap.

  • Após a confirmação no OZloc, é criado a ordem no OZneutral e na interface do OZneutral é exibido um croqui com os dados do parceiro. A ordem criada é para determinar se uma porta está em uso ou não por um cliente.

  • Com a criação da ordem no OZneutral, o seus dados são passados para a integração criar um cliente no OZmap que terá como nome o nome da parceira, um código que por padrão será o código da ordem (o cliente pode solicitar que seja utilizado outro atributo como código no OZmap) e também receberá as informações de endereço e observações caso hajo alguma, e também é definido um ID de integração no cliente para que depois possa ser vinculado com a ordem no OZneutral.

Registrar Clientes Cancelados no OZmap

O processo de registrar clientes cancelados no OZmap ocorre da seguinte forma:

  • Primeiramente a ordem é cancelada no OZneutral, que por padrão ocorre por determinação da operadora, mas pode ser parametrizado também que ocorra por determinação da parceira.

  • Com isso quando a ordem é cancelada no OZneutral é buscado um cliente no OZmap com o id de integração correspondente, e é adicionado uma Tag [cancelado ozn] ao cliente no OZmap.

Informação de Caixas e Conexões

São repassadas as informações de caixas e conexões das ordens registradas no OZneutral a partir dos dados do cliente no OZmap.

  • Essas informações são buscadas no cliente OZmap a partir do id de integração que vincula a ordem no OZneutral ao cliente no OZmap.

  • Ao serem retornadas, essas informações podem ser visualizadas na lista de ordens do OZneutral, na qual cada ordem terá as informações de sua respectiva caixa, como nome, nome do splitter e número da porta. Além disso, ainda na interface do OZneutral na parte de detalhes da ordem, poderá ser visualizada a caixa com suas coordenadas e o comprimento de drop.

Integração Customizada

Essa integração é customizada de acordo com as regras de negócios estabelecidas pelo cliente. O cliente pode pedir a customização de certas funcionalidades entrando em contato com o suporte do OZneutral.

Cancelamento de Clientes no OZmap

O processo de cancelamento de clientes OZmap segue o seguinte fluxo:

  • Primeiramente deve ser cancelada uma ordem no OZneutral.

  • Após esse cancelamento, por padrão a integração busca um cliente com o id de integração correspondente no OZmap e remove o cliente e o imóvel do OZmap. Porém o cliente pode optar por algumas configurações diferentes de acordo com as regras de negócio desejadas, essas podendo ser:

    • Manter ou remover drop.

    • Remover o imóvel caso o cliente não esteja implantado, e caso o cliente esteja implantado, remover apenas o cliente e manter o imóvel.

Implantação de Clientes OZmap

A integração realiza a implantação do cliente no OZmap de acordo com o provisionamento da ordem OZneutral, podendo acontecer da seguinte forma:

  • Caso a ordem seja provisionada, o cliente com o id de integração correspondente a ordem OZneutral tem seu status atualizado para implantado no OZmap.

  • Caso a ordem seja desprovisionada, o cliente com o id de integração correspondente a ordem OZneutral tem seu status atualizado para não implantado no OZmap.

Atualização de dados de Ordem no OZneutral

O cliente também pode optar que os dados dos clientes OZneutral sejam atualizados sempre que haja alguma alteração no OZmap. Esse processo ocorre da seguinte forma:

  • A integração busca no OZmap a cada 5 minutos clientes OZneutral que tem código de integração correspondente a ordem no OZneutral.

  • Ao encontrar esses clientes, são filtrados os clientes OZmap que tiveram alteração de coordenadas, caixa/splitter/porta, se foi implantado, removida, entre outros.

  • Os clientes que tiveram alterações no OZmap são atualizados no OZneutral com as informações mais recentes.

Dados Acesso

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

Saiba mais sobre como configurar esses dados acionando o suporte do OZneutral.

OZmap

Parâmetro

Descrição

Exemplo

Parâmetro

Descrição

Exemplo

URL API

Endereço do OZmap, com a porta de serviço padrão.

https://cliente.ozmap.com.br:9994

Chave API

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

Questionário

Pergunta

Resposta

Pergunta

Resposta