Como Configurar XML API no Mikrotik: Passo a Passo

· Atualizado em
A XML API (Interface de Programação em XML) no Mikrotik é uma interface que permite automação e integração de sistemas externos com dispositivos RouterOS. Por meio de requisições em XML, é possível gerenciar configurações, coletar dados e monitorar a rede de forma programática.

Passo a Passo para Configurar e Utilizar a XML API no Mikrotik

1. Acesse o Mikrotik

  • Conecte-se ao dispositivo via WinBox, SSH, ou interface Web.

2. Verifique o Serviço API no Mikrotik

  • Confirme que o serviço API está habilitado: 
    /ip service print
  • Caso o serviço esteja desativado, ative-o e defina a porta: 
    /ip service set api enabled=yes port=8728

3. Habilite a API SSL (opcional)

  • Para conexões seguras, habilite o API-SSL: 
    /ip service set api-ssl enabled=yes port=8729 certificate=MyCert
  • certificate: Certificado SSL configurado para segurança (opcional).

4. Crie um Usuário para Acesso API

  • Adicione um usuário com permissões específicas para acessar a API: 
    /user add name=api_user group=full password=senha123

5. Configure Regras de Firewall para API (opcional)

  • Restrinja o acesso à API para IPs confiáveis: 
    /ip firewall filter add chain=input protocol=tcp dst-port=8728 src-address=192.168.1.100 action=accept
/ip firewall filter add chain=input protocol=tcp dst-port=8728 action=drop

6. Teste a Conexão com a XML API

  • Use ferramentas como Postman ou scripts para enviar requisições XML ao Mikrotik:
    • URL de exemplo: http://192.168.1.1:8728
    • Exemplo de comando em Python para conectar à API:
      import ssl from routeros_api import RouterOsApiPoolconnection = RouterOsApiPool('192.168.1.1', username='api_user', password='senha123', plaintext_login=True) api = connection.get_api() result = api.get_resource('/interface').get() print(result) connection.disconnect()

7. Integre com Sistemas de Automação

  • Utilize a XML API para:
    • Automatizar configurações (ex.: criação de regras de firewall).
    • Monitorar estatísticas da rede (uso de banda, status de interfaces).
    • Criar relatórios customizados de dispositivos.

8. Monitore o Uso da API

  • Acompanhe conexões e requisições feitas à API: 
    /log print where topics=api

Considerações Finais

A XML API no Mikrotik é uma ferramenta poderosa para integração e automação, permitindo que sistemas externos gerenciem e monitorem dispositivos RouterOS de maneira eficiente.