MikroTik

How to Configure API Proxy on MikroTik: Complete Tutorial

· Atualizado em 5 min de leitura
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.

Prerequisites for Configuring API Proxy on MikroTik

Antes de começar, verifique se você possui os seguintes itens:
  • Acesso ao dispositivo Mikrotik (via Winbox ou CLI).
  • Basic knowledge of the MikroTik API and network configuration.

1. Accessing 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. Enabling the API Proxy on 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.

CLI command example:

RouterOS
/ip service set api disabled=no

3. Configuring Permissions for 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.

CLI command example to create a user for the API Proxy:

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

4. Configuring the Firewall to Allow API Proxy Access

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.

CLI command example to allow traffic on port 8728:

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

5. Testing Access 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. Verify that you receive a proper response from MikroTik, indicating that the API service is working.

CLI command example to test via API:

RouterOS
/interface print

6. Monitoring API Proxy Access

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. Filter the logs to view connection attempts to the API service.

CLI command example to view access logs:

RouterOS
/log print where message~"API"

7. Using the API Proxy for Automation and Monitoring

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).

CLI command example to automate via API:

RouterOS
/interface ethernet set ether1 disabled=yes

8. Disabling the API Proxy (If Necessary)

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.

CLI command example to disable the API Proxy:

RouterOS
/ip service set api disabled=yes

Conclusion on Configuring API Proxy on 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!