...
OBS: “contrato“ no SGP deve ser igual ao “code” do cliente no OZmap para que seja encontrado.
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 OZmap
...
Clientes com status "Cancelado" ou "Inviabilidade Técnica" no SGP são removidos do OZmap.
...
Desativado
...
Criar Clientes Automaticamente no OZmap
...
Clientes que existem no SGP porém não existem no OZmap serão criados no OZmap caso a caixa do cliente no SGP seja encontrada pelo nome no OZmap.
...
Desativado
...
Considerar o Projeto na Criação de Novos Clientes no OZmap
...
Somente será criado o cliente no OZmap cuja o projeto da caixa OZmap tenha o nome igual ao projeto do cliente no SGP.
...
Desativado
...
Remover Completamente o Imóvel do Cliente SGP Cancelado no OZmap
...
Ao cancelar um cliente no SGP, e o mesmo não é uma reserva no OZmap, o imóvel e cliente são removidos completamente do OZmap.
...
Desativado
...
Desconectar o Imóvel do Cliente SGP Cancelado da Porta do Splitter OZmap
...
Ao cancelar um cliente no SGP e o mesmo não é uma reserva no OZmap, o imóvel dele será desconectado da porta do splitter OZmap, liberando ela para novas conexões. O imóvel e drop continuarão existindo no OZmap, conectados a caixa, mas desconectado do splitter.
...
Desativado
...
Criar o Cliente SGP no OZmap ao Redor da Caixa
...
O Cliente SGP será criado ao redor da caixa OZmap, ignorando as coordenadas preenchidas no SGP.
...
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
...
São buscados todos os clientes que existem no SGP e que não existem no OZmap (procurando pelo código do cliente OZmap semelhante ao contrato SGP).
A partir desses clientes encontrados, é analisado se ele está conectado a um splitter no SGP. (Para criar no OZmap é necessário estar conectado).
Com o cliente possuindo um splitter e o status não está como cancelado no SGP, vamos no OZmap buscar uma caixa com nome IGUAL ao nome existente no splitter do SGP, se for encontrada, criamos o cliente no OZmap com os dados necessários e conexão com a caixa.
Caso a caixa exista no OZmap, mas não tenha splitter, o cliente é criado na caixa sem conexão.
Caso a caixa exista no OZmap e tenha splitter, criamos o cliente no splitter e na porta indicada pelo SGP.
Caso a caixa não exista no OZmap, o cliente não será criado.
Caso a configuração de considerar o nome de projeto na criação de novos clientes esteja ativa, o cliente somente será criado no OZmap caso o projeto da caixa OZmap tenha o nome igual ao projeto do cliente no SGP.
Caso a configuração de criar o cliente SGP ao redor da caixa no OZmap estiver desativada e, as coordenadas do endereço do cliente estiverem preenchidas no SGP, ao criar o novo cliente no OZmap, ele será posicionado na mesma coordenada do SGP no OZmap.
Se a configuração de criar o cliente SGP ao redor da caixa no OZmap estiver ativa, é ignorado as coordenadas preenchidas no SGP e, o cliente SGP é criado ao redor da caixa no OZmap.
Implantação e Atualização de Clientes (Nome, Potência (RX), Status de Conexão e Endereço).
...
Cliente é removido por completo do imóvel;
São adicionadas informações do cliente removido (Nome, Código, Data) nas observações do imóvel;
Se a configuração de desconectar o imóvel do cliente cancelado da porta do splitter estiver ativa, o imóvel é desconectado da porta do splitter no OZmap, liberando a porta para novas conexões;
Se a configuração de remover completamente o imóvel do cliente cancelado estiver ativa, o imóvel e o cliente são removidos por completo e nenhuma conexão com splitter é mantida;
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 OZmap | Clientes com status "Cancelado" ou "Inviabilidade Técnica" no SGP são removidos do OZmap. | Desativado |
Criar Clientes Automaticamente no OZmap | Clientes que existem no SGP porém não existem no OZmap serão criados no OZmap caso a caixa do cliente no SGP seja encontrada pelo nome no OZmap. | Desativado |
Considerar o Projeto na Criação de Novos Clientes no OZmap | Somente será criado o cliente no OZmap cuja o projeto da caixa OZmap tenha o nome igual ao projeto do cliente no SGP. | Desativado |
Remover Completamente o Imóvel do Cliente SGP Cancelado no OZmap | Ao cancelar um cliente no SGP, e o mesmo não é uma reserva no OZmap, o imóvel e cliente são removidos completamente do OZmap. | Desativado |
Desconectar o Imóvel do Cliente SGP Cancelado da Porta do Splitter OZmap | Ao cancelar um cliente no SGP e o mesmo não é uma reserva no OZmap, o imóvel dele será desconectado da porta do splitter OZmap, liberando ela para novas conexões. O imóvel e drop continuarão existindo no OZmap, conectados a caixa, mas desconectado do splitter. | Desativado |
Criar o Cliente SGP no OZmap ao Redor da Caixa | O Cliente SGP será criado ao redor da caixa OZmap, ignorando as coordenadas preenchidas no SGP. | Desativado |
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
Logs
Os logs desta integração estão disponíveis no endereço: https://<cliente>.ozmap.com.br/integrations/sgp/logs.
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Sim, atualmente são opcionais algumas funcionalidades | Cancelar Clientes, Criar Clientes, Considerar Projetos na Criação de Clientes, Criar Clientes ao Redor da Caixa, Remover Imóvel Completamente e Desconectar o Imóvel do Cliente Cancelado da Porta do Splitter. |
É possível alterar o mapeamento de status definidos? Ex: Status 7 no SGP ser OK no OZmap | Não, até a presente versão o mapeamento de status é fixo, é algo possível de ser feito mediante pedido de melhoria. | Atualização de Status |
É possível manter o imóvel no OZmap após o cancelamento do cliente? | Sim, se o cliente estiver com status “implantado” no OZmap e a configuração de “Remover Imóvel Completamente” estiver desativada, o imóvel permanecerá existindo e ocupando porta no OZmap. | - |
É possível criar um cliente SGP no OZmap em uma porta que já esteja ocupada por um imóvel? | Não, na funcionalidade de criar clientes da integração irá dar erro, independente da porta estar ocupada por um cliente ou imóvel. | Criar Clientes |
É possível remover o imóvel OZMap do cliente SGP cancelado da porta do Splitter OZmap? | Sim, com a configuração de “Desconectar Imóvel do Splitter”, ao cancelar um cliente no SGP que tenha o status “Implantado” no OZmap, o imóvel é desconectado da porta do splitter no OZmap. | Desconectar o Imóvel do Cliente SGP Cancelado da Porta do Splitter OZmap |
Preciso criar o projeto e o cliente nos dois sistemas ou em um só? | Atualmente, só criando o cliente no SGP e atribuindo um splitter a ele, ja é o suficiente para ele ser criado no OZmap. | Criar Clientes |
Na configuração de considerar o nome do projeto na criação de clientes do SGP no OZmap a acentuação é levada em conta? | Sim, a acentuação e as letras maiusculas e minusculas são levadas em conta, por isso, os nomes nos dois sistemas devem ser identicos. | Considerar o Projeto. |
...