...
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
|---|---|---|
Criação de Clientes | Criação de clientes no OZmap com base na leitura de novos clientes no Integrator. | Integrator=> OZmap |
Cancelamento de Clientes | Remoção de clientes no OZmap com base na leitura de clientes cancelados no Integrator. | Integrator => OZmap |
Implantação de clientes | Ativação (Implantar) cliente no OZmap de acordo com status de serviço ativo para cliente no Integrator. | Integrator => OZmap |
Funcionalidades
Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.
...
São lidos todos os clientes Integrator.
Para cada cliente Integrator que possua a descrição de serviço diferente de “Cancelado”, é buscado um cliente no OZmap cujo código seja igual ao código de cliente-numero de plano do cliente Integrator (Ex.: 777-888).
Caso seja encontrado, se no Integrator a descrição de serviço for igual a “Serviço Habilitado” e no OZmap o cliente estiver como “Não implantado”, o estado de implantação no OZmap é alterado para “Implantado”.
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 - Geral
Parâmetro | Descrição | Padrão |
|---|---|---|
Usar porta e splitter Integrator na criação de clientes no OZmap | Ao criar um cliente no OZmap, buscar um splitter e porta correspondentes no OZmap para o dado de porta e splitter lidos no serviço Integrator deste cliente. | Desativado |
Expressão regular para identificação de nome de caixa no Integrator | Expressão utilizada para extrair o nome da caixa no serviço Integrator para buscar caixa correspondente no OZmap. |
|
Expressão regular para identificação de nome de projeto no Integrator | Expressão utilizada para extrair o nome do projeto no serviço Integrator para buscar caixa em projeto correspondente no OZmap. |
|
Considerar projeto na busca de caixas para criação de clientes no OZmap | Ao buscar uma caixa Integrator no OZmap, o projeto para a caixa Integrator deve ser correspondente ao projeto da caixa encontrada no OZmap. | Desativado |
Considerar cidade no Integrator como nome de projeto OZmap na busca de caixas para criação de clientes no OZmap | Quando ativa a opção de considerar projeito na busca de caixas, a integração considera o nome da cidade definida no endereço do serviço Integrator como nome de projeto para a busca da caixas no OZmap. | Desativado |
Remover imóvel OZmap em cancelamentos de cliente Integrator | Quando um cliente for cancelado no Integrator, a integração irá remover o cliente e o imóvel do OZmap. | Desativado |
Configurações Específicas - Funcionalidades
Parâmetro | Descrição | Padrão |
|---|---|---|
Cancelamento de clientes | Utilizar a funcionalidade de cancelamento de clientes em cada sincronização. | Desativado |
Criação de clientes | Utilizar a funcionalidade de criação de clientes em cada sincronização. | Ativado |
Dados Acesso
https://docs.google.com/forms/d/1Z2ZyUkt3D9iyv0YS9xHzl3QZwaNYalF__zTNxv1o6fs
...
Dados de acesso necessários para buscar informações via API no sistema Integrator. (Estes dados devem ser fornecidos no questionário inicial)
Parâmetro | Descrição | Exemplo |
|---|---|---|
URL | Endereço do servidor Integrator. | https://integrator.cliente.com.br/integrator.server.php |
Usuário | Nome de usuário para chamadas API ao Integrator. | - |
Senha | Senha para chamadas API ao Integrator. | - |
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:
...
https://cliente.ozmap.com.br/integrations/integrator/logs
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Sim, as funcionalidades de criação e cancelamento de clientes são opcionais. | Criação de clientes Cancelamento de clientes |
É possível atualizar dados dos clientes pela integração (como nome / caixa / porta)? | Não, atualmente a integração não realizar atualização destas informações no OZmap e nem no Integrator. | - |
É possível desconectar o imóvel do splitter OZmap no momento do cancelamento? | Atualmente não, mas é possível implementar via sugestão de melhoria. | - |
É possível remover o imóvel do OZmap no momento do cancelamento? | Sim, o parâmetro “Remover imóvel OZmap em cancelamentos de cliente Integrator” atende essa demanda. | Cancelamento de clientes |
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.