Antes de iniciar o desenvolvimento da aplicação, verifique se a API está ativa dentro do sistema Ravi em DNS > Configurações > Ativar 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 do Ravi Monitor, normalmente uma mensagem será retornada, como por exemplo: {“msg”:”Usuário sem permissão de acesso”}

DNS Recursivo

Exemplo de script em PHP para receber a listagem de acompanhamento das requisições recebidas. Os dados são atualizados a cada 60 segundos.

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

{
    "total_num_queries":"10672",
    "total_num_cachehits":"10097",
    "total_num_cachemiss":"575",
    "total_num_prefetch":"108",
    "total_num_recursivereplies":"578",
    "up":"1845654",
    "A":"7376",
    "AAAA":"2201",
    "ANY":"11",
    "CNAME":"4",
    "msg":"0",
    "rrset":"56622656",
    "PTR":"43",
    "avg":"0",
    "max":"6"
}

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=recursivo

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

DNS Autoritativo

Listagem

Exemplo de script em PHP para receber a listagem de acompanhamento dos domínios e suas entradas.

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

[
    {
        "id":"1",
        "dominio":"dominio.com.br",
        "entradas":
        [
            {"id":"1","valor":"ns1","tipo":"A","host":"192.168.1.100"},
            {"id":"2","valor":"ns2","tipo":"A","host":"192.168.1.101"},
            {"id":"7","valor":"www","tipo":"A","host":"192.168.1.100"}
        ]
    },
    {
        "id":"2",
        "dominio":"outrodominio.com.br",
        "entradas":
        [
            {"id":"4","valor":"ns1","tipo":"A","host":"192.168.2.100"},
            {"id":"5","valor":"ns2","tipo":"A","host":"192.168.2.101"}
        ]
    }
]

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=autoritativo&dom={dominio}

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

Adicionando domínio

Exemplo de script em PHP para adicionar um novo domínio:

Ao consumir a API e o domínio em questão for salvo 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=add_dom&dom={dominio}

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

Adicionando subdomínio

No exemplo de script em PHP abaixo estamos adicionando uma entrada do tipo A para o subdomínio loja direcionando para o IP 192.168.10.30 no domínio teste.com.br

Ao consumir a API e o subdomínio em questão for salvo com sucesso o retorno esperado 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={teste}&senha={senha}&acao=add_subdom&dom={dominio}&subdom={subdominio}&host={host}&tipo={tipo}&comment=

Lembrando que é necessário substituir o domínio, subdominio, host, token, usuário e senha pelos valores reais.

Pesquisar subdomínio

No exemplo de script em PHP abaixo estamos pesquisando por uma entrada do tipo A para o subdomínio loja no domínio teste.com.br

Ao consumir a API e o subdomínio em questão for encontrado o retorno será: {“msg”:”true”} caso contrário o retorno será {“msg”:”false”}

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=pesquisar_subdom&dom={dominio}&subdom={subdominio}&tipo={tipo}

Lembrando que é necessário substituir o domínio, subdominio, tipo, token, usuário e senha pelos valores reais.

Deletando subdomínio

No exemplo de script em PHP abaixo estamos deletando o subdomínio loja que é uma entrada do tipo A do domínio teste.com.br

Ao consumir a API e o subdomínio em questão for deletado 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=delete_subdom&dom={dominio}&subdom={subdominio}&tipo={tipo}

Lembrando que é necessário substituir o domínio, subdomínio, tipo, token, usuário e senha pelos valores reais.

Deletando domínio

No exemplo de script em PHP abaixo estamos deletando o domínio teste.com.br e todos os seus subdomínios.

Ao consumir a API e o domínio em questão for deletado 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=delete_dom&dom={dominio}

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