Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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 pelo OZmap.

Tipo de Integração

A integração OZmap-OZneutral é do tipo Passiva-indireta.

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 com o OZmap pode ser dividida em duas, uma sendo a integração padrão e outra sendo a customizada.

Resumo de funcionalidades

  • Integração Padrão

Funcionalidade

Descrição

Direção da integração

Sincronização de clientes OZneutral

Criação e cancelamento de clientes no OZmap, com base nos dados de clientes OZneutral.

OZneutral => OZmap

  • Integração Customizada

Funcionalidade

Descrição

Direção da integração

Sincronização de clientes OZneutral

Atualização e exclusão de clientes no OZmap, com base nos dados de cliente OZneutral.

OZneutral => OZmap

Atualização de clientes

Atualiza os clientes no OZneutral caso haja alguma alteração no cliente 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

Sincronização de clientes

A sincronização de clientes OZneutral se baseia na criação e cancelamento de clientes no OZmap com base nos dados de clientes OZneutral, ocorrendo da seguinte forma:

  • O processo de criação de clientes ocorre da seguinte forma:

    • É cadastrado um lead no OZneutral e apartir desse lead é possível criar uma ordem, que ao ser criada é criado um cliente no prórpio OZneutral. Após a criação desse cliente os dados são passados para criar um cliente no OZmap que terá como nome o nome da parceira, o código 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.

  • Em caso de cancelamento da ordem pela operadora no OZneutral, é adicionado uma Tag [cancelado ozn] ao cliente no OZmap.

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.

Sincronização de clientes

A sincronização de clientes se baseia nos dados dos clientes OZneutral para realizar a atualização ou cancelamento dos mesmo no OZmap.

  • Atualização de cliente

    • Pode ocorrer quando há um provisionamento da ordem no OZneutral e a partir disso o cliente é atualizado no OZmap. Caso a ordem for provisionada o cliente tem seu status atualizado para implantado no OZmap. Já caso a ordem seja desprovisionada o cliente tem seu status atualizado para não implantado.

  • Exclusão de clientes

    • Já o processo de exclusão ocorre caso uma ordem seja cancelada no OZneutral, por padrão a integração remove o cliente e o imóvel no 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

      • Caso o cliente esteja implantado, remover apenas o cliente e manter o imóvel

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 OZneutral.

OZmap

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

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 OZneutral 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 integrador.

Questionário

Pergunta

Resposta

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.