Antes de iniciar o desenvolvimento da aplicação, verifique se a API está ativa dentro do sistema Ravi em OLT > Configurações > API

Consumindo a API

A API pode ser consumida de qualquer linguagem de programação que consiga realizar uma requisição para Web e receber o retorno da mesma.

O retorno será do tipo JSON de acordo com os dados solicitados. Vale lembrar que a API respeita a configuração de permissões de usuário do Ravi Monitor, normalmente uma mensagem será retornada, como por exemplo: {“msg”:”Usuário sem permissão de acesso”}

Listagem

Exemplo de script em PHP para receber a listagem de acompanhamento das requisições recebidas. Os dados são atualizados conforme o cronograma de aferição configurado.

Abaixo segue um exemplo do retorno ao consumir a API considerando que não haja nenhum erro:

{
    "olts":
    [
        {
            "id":"1","nomeOlt":"OLT-FH-SP","cronograma":"Executar a cada 2 horas","ip":"192.168.10.11","marca":"Fiberhome","ultimaSincronizacao":"2022-12-07 06:19:57","onus":
            [
                {"slot":"1","pon":"1","onu":"15","provisionamento":"Slot\/Placa: 1 Pon: 1 ONU: 15","descricao":"","login":"","mac-sn":"CMSZ3b1cf884","rxonu":"-16.05","txonu":"2.45","oltrx":"","voltagem":"3.32","temperatura":"43.41","distancia":"2807","biascurrent":"13.35","status":"1","uptime":"","ultimaSincronizacao":"2022-12-08 06:47:00"},
                {"slot":"1","pon":"9","onu":"35","provisionamento":"Slot\/Placa: 1 Pon: 9 ONU: 35","descricao":"","login":"","mac-sn":"CMSZ3b1cf9a2","rxonu":"-20.17","txonu":"2.39","oltrx":"","voltagem":"3.28","temperatura":"44.76","distancia":"1853","biascurrent":"13.4","status":"1","uptime":"","ultimaSincronizacao":"2022-12-08 06:47:00"}
            ]
        },
        {
            "id":"2","nomeOlt":"OLT-FH-RJ","cronograma":"Executar a cada 2 horas","ip":"192.168.10.12","marca":"Fiberhome","ultimaSincronizacao":"2022-12-07 18:01:43","onus":
            [
                {"slot":"4","pon":"15","onu":"4","provisionamento":"Slot\/Placa: 4 Pon: 15 ONU: 4","descricao":"","login":"","mac-sn":"CMSZ3b1cf774","rxonu":"-26.99","txonu":"2.42","oltrx":"","voltagem":"3.34","temperatura":"53.58","distancia":"1519","biascurrent":"15.8","status":"1","uptime":"","ultimaSincronizacao":"2022-12-07 18:00:00"},
                {"slot":"1","pon":"11","onu":"11","provisionamento":"Slot\/Placa: 1 Pon: 11 ONU: 11","descricao":"","login":"","mac-sn":"CMSZ3b1cf887","rxonu":"","txonu":"","oltrx":"","voltagem":"","temperatura":"","distancia":"","biascurrent":"","status":"2","uptime":"","ultimaSincronizacao":"2022-12-08 06:47:00"}
            ]
        }
    ]
}

Também é possível consumir a API via GET montando o link com o padrão:

dominio.com.br/webservice/api.php?token={token}&usuario={usuario}&senha={senha}&acao=onu_list

Lembrando que é necessário substituir o token, usuário e senha pelos valores reais.

Atualizar login e/ou descrição de uma ONU

Exemplo de script em PHP para atualizar descrição e login de uma ONU. O usuário configurado precisa ter permissão de acesso.

Ao consumir a API e a ONU em questão for atualizada com sucesso o retorno será: {“msg”:”ok”}

Também é possível consumir a API via GET montando o link com o padrão:

dominio.com.br/webservice/api.php?token={token}&usuario={usuario}&senha={senha}&acao=onu_update&mac_sn=ZTEGcce8eef5&descricao=&login=

Lembrando que é necessário substituir o mac_sn, token, usuário e senha pelos valores reais e preencher o campo descrição ou login.