Essa documentação trata do serviço externo SGP. O serviço externo é acessado via API. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadas.
Descrição
O Sistema de Gerenciamento para Provedores de Internet é uma ferramenta de gestão completa, com módulos do sistema integrados e prontos para sua empresa funcionar de forma organizada e otimizada, os módulos do sistema são integrados.
Dados Acesso
https://docs.google.com/forms/d/1ZrFR1QU4xM7ag_EU-whzzz-oA6es7anXZFCM1GvTn8M/edit
SGP
Dados de acesso necessários para buscar informações via API no sistema SGP. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
---|---|---|
URL | Endereço do servidor SGP. | https://sgp.cliente.com.br |
Token | Token provido pelo cliente para acessar o serviço. | 59123456-2e1d-479a-9b49-5513b2aac54f |
Nome do App | Nome que o cliente deu para a conta de serviço da integração dentro do seu serviço externo. | OZmap |
OZmap
Parâmetro | Descrição | Exemplo |
---|---|---|
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
Para validação e execução da integração no ambiente de produção, é necessário que sejam liberados no servidor do cliente os IPs utilizados pelo OZmap:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
54.207.162.199
Configurações Base
Parâmetro | Descrição | Padrão |
---|---|---|
Tempo entre Sincronizações | Tempo aguardado entre as sincronizações realizadas pela integração | 15 minutos |
Configurações Específicas - Clientes
Parâmetro | Descrição | Padrão |
---|---|---|
Cancelar Clientes Automaticamente no ERP | Clientes com status "Cancelado" ou "Inviabilidade Técnica" são cancelados. | Desativado |
Criar Clientes Automaticamente no OZmap | Clientes que existem no ERP porém não existem no OZmap serão criados caso a caixa seja encontrada pelo nome. | Desativado |
Considerar o Projeto na Criação de Novos Clientes | Se o projeto do ERP possuir o mesmo nome no OZmap, o cliente será criado vinculado ao projeto no OZmap. | Desativado |
Logs
Os logs desta integração estão disponíveis no endereço: https://<cliente>.ozmap.com.br/integrations/sgp/logs.
Resumo das funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Atualização da porta do cliente | Atualiza a porta na qual o cliente se encontra cadastrado no ERP. | OZMap => SGP |
Sincronização de condomínios | Criação de caixas no ERP para representar os splitters de um condomínio. | OZMap => SGP |
Sincronização de dados de clientes | Sincronização dos dados dos clientes cadastrados, podendo incluir status e potência. | OZMap <= SGP |
Cancelamento de clientes | Cancelamento de clientes que se encontram cancelados no ERP. | OZMap <= SGP |
Ativação de clientes | Ativação de clientes que se encontram ativados no ERP. | OZMap <= SGP |
Criação de clientes | Criação de clientes que se encontram cadastrados no ERP. | OZMap <= SGP |
Sincronização de caixas | Sincronização e criação de caixas que se encontram cadastradas no ERP. | OZMap <=> SGP |
//Se é do OZMap -> o serviço externo ou o contrário. Funcionalidades que tem bidirecionalidade devem ser identificadas com <->. A direcionalidade é definida por de onde está a “fonte da verdade” e para onde vai ser sincronizado.
Funcionalidades inversas
Funcionalidades marcadas como OZMap <- serviço externo.
Criação de clientes
São identificados todos os contratos que existem no SGP(Contrato) e não existem no OZmap (Código do cliente).
A partir desses clientes, é buscada qual Caixa/Splitter/Porta ele está conectado no SGP.(Se tiver conectado).
Após identificar a caixa, vamos no OZmap buscar uma caixa com nome IGUAL ao nome existente no SGP, se for encontrada criamos o cliente no OZmap com os dados necessários e conexão com a caixa.
*Caso a caixa exista, mas não tenha splitter, o cliente é criado na caixa sem conexão.
*Caso a caixa exista e tenha splitter, criamos o cliente no splitter e na porta indicada no ERP.
Atualização de campos (Nome, Potência (RX), Estado de Ativação, Status de Conexão).
A cada X minutos, a integração busca os contratos e conexões atualizadas do SGP.
Identifica os clientes no OZmap pelo código(id) de contrato existente no ERP, e atualiza os campos baseado nas seguintes regras:
Nome: Se houve alteração no SGP (OZmap != SGP) considera nome do ERP. (Qualquer alteração de nome no OZmap será descartada)
Potência (RX): Caso o SGP retorne essa informação atualizamos o campo “Potência lida” existente no cliente do OZmap. Essa atualização é feita caso a potência seja diferente da existente no OZmap atualmente.
Estado de ativação: Caso o cliente tenha o Status de contrato “Ativo” (1), o cliente e tenha estado “Não Implantado” no OZmap, ele é atualizado para o estado “Implantado” automaticamente.
Status de Conexão: Caso o SGP retorne essa informação (Depende de suporte para o dispositivo, todo suporte para essa parte é deles), ela é atualizada no OZmap:
“Online” no ERP ⇒ “OK” no OZmap
“Offline” no ERP ⇒ “ERROR” no OZmap
Cancelamento de clientes
A cada X minutos, a integração busca os contratos e conexões atualizadas do SGP.
Identifica os clientes no OZmap pelo código(id) de contrato existente no ERP, e identifica contratos cancelados que ainda existem no OZmap:
Contrato é considerado cancelado se tiver no status: CANCELADO(3) ou INVIABILIDADE_TECNICA(5) no SGP.
Caso o cliente esteja “Implantado” no OZmap, é considerado um cancelamento de cliente já ativo, e o cancelamento se dá dessa forma:
Cliente é removido do Imóvel
Imóvel permanece conectado ao Splitter.
São adicionadas informações do cliente removido(Nome, Código, Data) nas observações do imóvel.
Caso o cliente esteja “Não Implantado” no OZmap, é considerada uma “Desistência” (Quando um cliente não chega a ser ativado, e cancela), e o cancelamento se da dessa forma:
Imóvel e cliente são removidos por completo
Nenhuma conexão com splitter é mantida.
Questionário
Pergunta | Resposta | Funcionalidade |
---|---|---|
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.
Add Comment