...
Essa documentação trata do serviço externo MKSolutionsMKsolutions. O serviço externo é acessado via banco de dados. As funcionalidades descritas aqui indicam as capacidades e os requisitos da integração, bem como o questionário e as funcionalidades relacionadas.
| Table of Contents | ||||
|---|---|---|---|---|
|
Tipo de Integração
A integração OZmap-MKsolutions é do tipo Ativa.
Descrição
O MKSolutions MKsolutions é um sistema de Gestão (ERP) focado no controle financeiro, estoque e documentação para Provedores de internet.
As funcionalidades da integração entre OZmap e MKSolutions MKsolutions se baseiam na busca ao banco de dados disponibilizado pelo ERP, sendo essas funcionalidades a ativação, atualização e cancelamento de clientes no OZmap, com base nas leituras do MKSolutions.
Dados Acesso
MKSolutions
Dados de acesso necessários para que a integração possa buscar informações via banco de dados no sistema MKSolutions. (Estes dados devem ser fornecidos no questionário inicial)
...
Parâmetro
...
Descrição
...
Exemplo
...
IP Banco de Dados
...
IP do banco de dados disponibilizado pelo MKSolutions.
...
190.13.10.3
...
Nome Banco de Dados
...
Nome do banco de dados disponibilizado pelo MKSolutions.
...
mkData3.0
...
Porta de acesso Banco de Dados
...
Porta de acesso ao banco de dados disponibilizado pelo MKSolutions.
...
5432
...
Usuário
...
Nome de usuário no banco de dados criado para a integração.
...
cliente_r
...
Senha
...
Senha de acesso do usuário no banco de dados.
...
-
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)
...
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
Logs
A integração ainda não possui logs.
MKsolutions.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Implantação de clientes ativos | Ativação (Implantar) cliente no OZmap de acordo com o que é informado pelo |
MKsolutions |
MKsolutions => OZmap | |
Remoção de clientes cancelados | Remoção no OZmap de clientes cancelados de acordo com o que é informado pelo |
MKsolutions, mantendo a propriedade conectada com o splitter no OZmap |
MKsolutions => OZmap | |
Atualização de dados do cliente | Atualização de nome e endereço de clientes no OZmap de acordo com o que é informado pelo |
MKsolutions |
MKsolutions => OZmap |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
Implantação de clientes ativos
Ativação (implantação) dos clientes ativos no OZmap baseado na leitura informada pelo MKSolutionsMKsolutions, respeitando as regras abaixo:
São buscados todos os clientes ativos do MKSolutionsMKsolutions, ou seja, clientes que tenham uma data de ativação e não tenham motivo de cancelamento no banco de dados do MKSolutionsMKsolutions;
Para cada cliente encontrado, buscamos um cliente no OZmap com um código semelhante ao código de contrato do MKSolutions“Código Utilizado para Identificar as Conexões” no MKsolutions;
Caso seja encontrado, e o cliente no OZmap esteja em status “Não implantado” o campo do OZmap é atualizado para “implantado”
...
“Implantado”.
Remoção de clientes cancelados
Remoção dos clientes cancelados no OZmap baseado na leitura informada pelo MKSolutionsMKsolutions, de acordo com as regras abaixo:
São buscados todos os clientes cancelados do MKSolutionsMKsolutions, ou seja, clientes que tenham o motivo de bloqueio como cancelado e tenham um contrato válido./inativo;
Para cada cliente encontrado, buscamos um cliente no OZmap com um código semelhante ao código de contrato do MKSolutions“Código Utilizado para Identificar as Conexões” no MKsolutions;
Caso seja encontrado, o cliente é removido do OZmap, mantendo a propriedade conectada com o splitter no OZmap.
Atualização de dados de clientes
Atualização de dados de clientes no OZmap baseado na leitura informada pelo MKSolutionsMKsolutions, de acordo com as regras abaixo:
São buscados todos os clientes ativos do MKSolutionsMKsolutions, ou seja, clientes que tenham uma data de ativação e não tenham motivo de cancelamento no banco de dados do MKSolutionsMKsolutions
Para cada cliente encontrado, buscamos um cliente no OZmap com um código semelhante ao código de contrato do MKSolutions“Código Utilizado para Identificar as Conexões” no MKsolutions;
Caso seja encontrado e o valor de nome e/ou endereço no OZmap esteja diferente do trazido pelo MKSolutionsMKsolutions, esses campos são atualizados no OZmap.
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
Parâmetro | Descrição | Padrão |
|---|---|---|
Atualização de dados de clientes | Atualiza dados (nome, endereço) de clientes de acordo com o que é disponibilizado pelo MKsolutions | Desativado |
Código Utilizado para Identificar as Conexões | Informação da conexão MKsolutions a ser comparada com código do cliente no OZmap para encontrar clientes correspondentes e realizar as ações da integração. Pode ser utilizado código de conexão ou contrato MKsolutions. IMPORTANTE: Precisa ser um código único no MKsolutions. | Código de conexão |
Dados Acesso
https://docs.google.com/forms/d/1xV7cYVwxWclgIduStkvYakGTgg5g2ZLgW_qxz4kHpws
MKsolutions
Dados de acesso necessários para que a integração possa buscar informações via banco de dados no sistema MKsolutions. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
|---|---|---|
IP Banco de Dados | IP do banco de dados disponibilizado pelo MKsolutions. |
|
Nome Banco de Dados | Nome do banco de dados disponibilizado pelo MKsolutions. |
|
Porta de acesso Banco de Dados | Porta de acesso ao banco de dados disponibilizado pelo MKsolutions. |
|
Usuário | Nome de usuário no banco de dados criado para a integração. |
|
Senha | Senha de acesso do usuário no banco de dados. | - |
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)
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Logs
A integração ainda não possui logs.
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Sim, mas apenas a atualização de nome e endereço de clientes é opcional, as funcionalidades de cancelamento e ativação de clientes sempre estarão ativas | Atualização de clientes |
É possível desconectar o imóvel do splitter após cancelamento de cliente no OZmap? | Não, atualmente essa configuração é fixa em manter o imóvel conectado ao Splitter no OZmap | Remoção de clientes cancelados |
Algum elemento OZmap é criado pela integração no MKsolutions? | Não, nenhum elemento OZmap é criado no MKsolutions. | - |
Algum elemento MKsolutions é criado pela integração no OZmap? | Não, nenhum elemento MKsolutions é criado no OZmap . | - |
É feito algum tipo de filtro nos clientes no OZmap para o seu cancelamento? | Não, nós só buscamos contratos de clientes cancelados MKsolutions como código no OZmap e os removemos, sem nenhum filtro adicional. | Remoção de clientes cancelados |
Clientes removidos (sem serem cancelados) no MKsolutions são removidos no OZmap? | Não, só clientes com contratos cancelados no MKsolutions serão removidos no OZmap. | Remoção de clientes cancelados |