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.
Dados Acesso
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 da integração ao Integrator. | - |
Senha | Senha para chamadas API da integração 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)
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.
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 |
|---|---|---|
Código de usuário integrator | ? | 01 |
Cancelamento de clientes | ||
Logs
Os logs da integração são disponibilizados no endereço: https://$cliente.ozmap.com.br/integrations/integrator/logs
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.
Atualização de status
Atualização do valor de status do cliente no OZmap baseado na leitura informada pelo SmartOLT. O campo “status” é atualizado no OZmap respeitando as regras abaixo.
São lidos os valores de status de todas as ONUs encontradas no SmartOLT.
Para cada ONU, buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, e o valor presente no OZmap seja diferente do valor trazido pelo SmartOLT, o campo do OZmap é atualizado. O valor de status segue o seguinte padrão:
Status SmartOLT | Status OZmap |
|---|---|
Online | OK (0) |
Offline | ERROR (1) |
Power fail | ERROR (1) |
Atualização de potência
Atualização do valor de potência lida no OZmap baseado na leitura informada pelo SmartOLT. O campo “Potência lida” é atualizado no OZmap respeitando as regras abaixo.
São lidos os valores de potência de todas as ONUs encontradas no SmartOLT.
Para cada ONU, buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, e o valor presente no OZmap seja diferente do valor trazido pelo SmartOLT, o campo “Potência lida” do OZmap é atualizado.
Implantação de clientes
Atualização do estado de implantação do cliente no OZmap baseado na leitura de potência informada pelo SmartOLT.
São lidos os valores de potência de todas as ONUs encontradas no SmartOLT.
Para cada ONU com potência válida (ou seja, que possuam potência de valor numérico diferente de 0), buscamos no OZmap um cliente que possua a ONU com Serial Number semelhante.
Caso seja encontrado, e o cliente esteja com estado de implantação “Não implantado” no OZmap, o campo é atualizado para “Implantado”.
Questionário
Pergunta | Resposta | Funcionalidade |
|---|---|---|
É possível utilizar apenas algumas das funcionalidades acima? | Não, no momento ainda não é possível escolher executar apenas uma ou mais das funcionalidades descritas. | - |
É possível alterar o status do cliente no OZmap com base na potência recebida do SmartOLT? | Não, no momento a atualização de status no OZmap ocorre somente pelo valor de status lido no SmartOLT. | - |
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.
Add Comment