Essa documentação trata da integração com o sistema RBX. A integração é realizada através de chamadas de API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.
Tipo de Integração
A integração OZmap-RBX é do tipo Passiva, desenvolvida pela equipe RBX.
Descrição
O RBX é um sistema de Gestão (ERP) focado no controle financeiro, estoque e documentação para provedores de internet.
As funcionalidades desta integração entre OZmap e RBX tem como foco principal a realização de consulta de viabilidade com reserva de porta, implantação e cancelamento de clientes no OZmap.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Viabilidade com Reserva de Porta no OZmap | Buscar viabilidade técnica no OZmap para um endereço de cliente ou equipamento RBX, e reservar uma porta no OZmap para sua instalação. | RBX => OZmap |
Implantação de Clientes no OZmap | Implantação de clientes RBX no OZmap, através da ligação de equipamento no RBX. | RBX => OZmap |
Cancelamento de Clientes e Reservas no OZmap | Remove reservas e clientes no OZmap, através do cancelamento de contrato ou desligamento de equipamento no RBX. | RBX => OZmap |
Sincronização de Caixas e Splitters no RBX | Cadastro, atualização e exclusão periódica de caixas e splitters no RBX, com base nos dados destes elementos no OZmap | OZmap => RBX |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Viabilidade com Reserva de Porta no OZmap
A Consulta de Viabilidade realizada pelo RBX no OZmap consiste em verificar a disponibilidade de atendimento para um novo cliente ou equipamento em determinada localidade, e ocorre da seguinte forma:
Dentro de cadastro de pedido do cliente, é acionado o menu “Viabilidade”, e selecionado “Viabilidade OZmap”;
O RBX irá realizar a consulta de viabilidade no OZmap, enviando as coordenadas correspondentes ao endereço do cliente para buscar caixas que não estejam “Em projeto”, e possuam splitter de atendimento com portas disponíveis no OZmap;
A busca de viabilidade realizada no OZmap é feita por raio, e a distância máxima para este raio de busca será a que estiver definida nas configurações do RBX (Parâmetro “Raio de viabilidade”).
Caso haja viabilidade no OZmap, o RBX exibirá uma mensagem como “Pedido com viabilidade no OZmap”, e em seguida, a lista de todas as caixas encontradas, e a situação de cada porta (livre, ocupada);
Implantação de Clientes no OZmap
Cancelamento de Clientes e Reservas no OZmap
Sincronização de Caixas e Splitters
Mantendo informações de portas livres e ocupadas para uso no RBX.
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 RBX.
OZmap
Parâmetro | Descrição | Exemplo |
|---|---|---|
API URL | Endereço da api 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 |
Raio de viabilidade | Raio de busca, em metros, para a consulta de viabilidade no OZmap | 150 |
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 RBX 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 | Funcionalidade |
|---|---|---|
Add Comment