Como Configurar API Proxy no Mikrotik: Tutorial Completo

· Atualizado em
O API Proxy no Mikrotik é uma funcionalidade poderosa que permite a você interagir com o Mikrotik de maneira remota, enviando comandos para o dispositivo de fora da rede local. O API Proxy facilita a gestão de redes Mikrotik ao permitir que você configure o roteador remotamente de maneira programática, o que é ideal para integrações com sistemas de automação ou soluções de monitoramento. Neste tutorial, você aprenderá como configurar o API Proxy no Mikrotik de forma simples e eficaz.

Pré-requisitos para Configurar API Proxy no Mikrotik

Antes de começar, verifique se você possui os seguintes itens:
  • Acesso ao dispositivo Mikrotik (via Winbox ou CLI).
  • Conhecimento básico sobre a API do Mikrotik e configurações de rede.

1. Acessando o Mikrotik

Para configurar o API Proxy, você precisará acessar o seu dispositivo Mikrotik:
  • Via Winbox: Baixe e execute o Winbox. Conecte-se ao seu Mikrotik usando o endereço IP ou MAC.
  • Via CLI: Use um terminal SSH para se conectar ao Mikrotik com seu nome de usuário e senha.

2. Habilitando o API Proxy no Mikrotik

Para configurar o API Proxy, você precisa garantir que o serviço API esteja ativado no Mikrotik. O serviço API permite que você se conecte remotamente ao Mikrotik através de uma interface programática.
  1. No menu IP, clique em Services.
  2. Encontre o serviço API e clique em Edit.
  3. Marque a opção Enabled para habilitar o API Proxy.
  4. Defina a Port para o serviço, que será usada para a conexão API (geralmente a porta 8728).
  5. Clique em OK para salvar a configuração.

Exemplo de comando CLI:

/ip service set api disabled=no

3. Configurando Permissões para API Proxy

Após habilitar o API Proxy, é importante garantir que apenas usuários autorizados possam acessar o serviço. Você pode configurar um usuário específico com permissões para interagir com o API Proxy.
  1. No menu System, clique em Users.
  2. Clique em Add para criar um novo usuário.
  3. Defina o Name e a Senha para o usuário.
  4. No campo Group, selecione full ou o grupo com permissões específicas que você deseja para o usuário.
  5. Clique em OK para salvar.

Exemplo de comando CLI para criar um usuário para o API Proxy:

/user add name="apiuser" password="sua_senha" group=full

4. Configurando o Firewall para Permitir o Acesso API Proxy

Se o seu Mikrotik estiver protegido por firewall, você precisará configurar uma regra para permitir a comunicação com o API Proxy. Para garantir o acesso remoto, adicione uma regra no firewall.
  1. No menu IP, clique em Firewall.
  2. Na aba Filter Rules, clique em Add para adicionar uma nova regra.
  3. Defina a Chain como Input, o Protocol como TCP e a Dst. Port como 8728 (porta padrão do API Proxy).
  4. Defina a Action como accept para permitir o tráfego.
  5. Clique em OK para salvar a regra.

Exemplo de comando CLI para permitir o tráfego na porta 8728:

/ip firewall filter add chain=input protocol=tcp dst-port=8728 action=accept

5. Testando o Acesso via API Proxy

Agora que você configurou o API Proxy, é importante testar se a conexão está funcionando corretamente. Para testar, você pode usar ferramentas como Postman ou API Client para enviar comandos para o Mikrotik e verificar se ele responde corretamente.
  1. Baixe e instale o Postman ou qualquer ferramenta de API de sua preferência.
  2. Conecte-se ao Mikrotik usando o IP público ou local e a porta configurada (por padrão, 8728).
  3. Envie um comando básico, como o seguinte:
    /interface print
  4. Verifique se você recebe uma resposta adequada do Mikrotik, indicando que o serviço API está funcionando.

Exemplo de comando CLI para testar via API:

/interface print

6. Monitorando o Acesso ao API Proxy

Após a configuração e teste, é essencial monitorar o uso do API Proxy para garantir que tudo esteja funcionando corretamente e identificar tentativas de acesso não autorizado.
  1. No menu System, clique em Log para visualizar os registros de acesso.
  2. Filtre os logs para visualizar as tentativas de conexão ao serviço API.

Exemplo de comando CLI para visualizar os logs de acesso:

/log print where message~"API"

7. Utilizando o API Proxy para Automação e Monitoramento

O API Proxy pode ser integrado a sistemas de automação, como scripts ou plataformas externas, para monitorar e configurar a rede Mikrotik de maneira programática. Aqui estão algumas possíveis utilizações:
  • Automatizar tarefas de configuração: Criar scripts para automatizar configurações de rede.
  • Monitorar desempenho: Usar o API Proxy para coletar dados de desempenho da rede e enviar para uma plataforma de monitoramento.
  • Integração com sistemas externos: Integrar o Mikrotik com outras plataformas de gerenciamento de rede, como sistemas de gerenciamento de infraestrutura de TI (ITSM).

Exemplo de comando CLI para automatizar via API:

/interface ethernet set ether1 disabled=yes

8. Desabilitando o API Proxy (Se Necessário)

Se, por algum motivo, você precisar desabilitar o API Proxy, basta seguir estes passos:
  1. No menu IP > Services, clique em API.
  2. Marque a opção Disabled para desabilitar o serviço.
  3. Clique em OK para aplicar a mudança.

Exemplo de comando CLI para desabilitar o API Proxy:

/ip service set api disabled=yes

Conclusão sobre Configuração de API Proxy no Mikrotik

Configurar o API Proxy no Mikrotik oferece uma maneira poderosa e flexível de gerenciar seu dispositivo de forma remota. Através da API, é possível automatizar tarefas, integrar o Mikrotik a outras plataformas e garantir um controle mais eficiente sobre sua rede. Com as etapas descritas neste tutorial, você pode configurar, testar e monitorar o API Proxy para otimizar o gerenciamento de sua rede. Gostou deste tutorial? Confira nossos outros guias sobre configuração de redes no Mikrotik e otimize sua segurança e conectividade!