Essa documentação trata do serviço externo Integrator. 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.
Tipo de Integração
A integração OZmap-Integrator é do tipo Ativa.
Descrição
O Integrator é um sistema ERP, CRM, Provisioning e Billing para empresas de telecomunicações.
As funcionalidades da integração entre OZmap e Integrator se baseiam na busca de clientes Integrator via API, e criação, implantação e cancelamento destes clientes no OZmap. Para o vínculo de clientes entre Integrator e OZmap, é necessário que o dado gerado pela concatenação das informações de código do cliente e numero do plano do Integrator (Ex.: 777-888) seja igual ao codigo do cliente no OZmap.
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.
Criação de clientes
Criação de cliente no OZmap baseado na leitura de clientes que existem no Integrator mas ainda não existem no OZmap:
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 não seja encontrado um cliente correspondente no OZmap, será feita a criação do cliente seguindo as regas:
Cliente deve ter uma caixa atribuída no serviço Integrator.
Integração busca no OZmap uma caixa correspondente a caixa no serviço Integrator, utilizando expressão regular para extrair o nome da caixa no Integrator. Caso a opção de usar projeto Integrator esteja ativa, a caixa no OZmap deve estar em projeto correspondente ao projeto no serviço Integrator.
Caso a caixa não seja encontrada no OZmap, o cliente não será criado.
Caso a caixa seja encontrada no OZmap, e se a opção de usar a porta de serviço integrator estiver ativa, será buscado o splitter e porta correspondentes no OZmap.
Se a integração encontrar splitter e porta do serviço Integrator correspondentes no OZmap, o cliente será criado no OZmap com estas informações.
Caso não seja encontrado splitter e porta correspondentes, o cliente será criado na caixa encontrada anterioremente, e conectado no primeiro splitter de atendimento e porta disponíveis nessa caixa no OZmap.
Cancelamento de clientes
Remoção de cliente no OZmap baseado na leitura de serviço cancelado do cliente no Integrator:
São lidos todos os clientes Integrator.
Para cada cliente integrator que possua a descrição de serviço “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, o cliente é removido do OZmap, seguindo as regras:
Se o cliente estiver como “Implantado” no OZmap, o cliente é excluído e o imóvel é mantido e permace conectado ao splitter.
Se o cliente estiver como “Não implantado” no OZmap, o cliente e o imóvel são excluídos do OZmap.
Implantação de clientes
Atualização do estado de implantação do cliente no OZmap baseado na leitura de serviço ativo do cliente no Integrator:
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 |
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
Integrator
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:
Servidor OZmap do cliente (ping cliente.ozmap.com.br)
54.207.162.199
Também se faz necessária a liberação dos mesmos IPs acima no próprio Integrator, normalmente por solicitação do cliente ao suporte Integrator.
Logs
Os logs desta integração estão disponíveis no endereço:
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? | Atualmente não, mas é possível implementar via sugestão de melhoria. | - |
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.
0 Comments