MT5 Manager API, Web API ou Server API: de qual sua corretora precisa?

O que é a MT5 Manager API?

A MT5 Manager API é a interface que a MetaQuotes oferece para você escrever seu próprio software de administração e gestão de um servidor MetaTrader 5. Tudo o que um funcionário do back office faz no terminal MT5 Manager — abrir contas, mudá-las de grupo, lançar depósitos, acompanhar posições, tratar solicitações de dealer — pode, em princípio, ser feito por um programa construído sobre ela.

Ela é entregue aos titulares de licença como parte dos pacotes para desenvolvedores da MetaQuotes, e não como download público, e a documentação fica no site de suporte da MetaQuotes, com acesso por login. Nos pacotes com que trabalhamos, é uma biblioteca nativa para Windows, com headers para C++ e wrappers para .NET; confira o pacote atual para a build do seu servidor, porque os detalhes mudam.

Como se comparam a Manager API, a Web API e a Server API?

O jeito mais rápido de distingui-las é perguntar onde o código roda e o que acontece se ele falhar. Os programas da Manager API e da Web API rodam fora do servidor e se conectam a ele; um plugin da Server API roda dentro dele, a cada evento relevante.

Onde entram a Gateway API e a Report API?

Elas completam o conjunto, mas respondem a outras perguntas. A Gateway API conecta o MT5 a outros sistemas de negociação e fluxos de dados, e é assim que provedores de liquidez e bolsas são acoplados; tratamos dela no guia da Gateway API do MT5. A Report API amplia os relatórios gerados pelo servidor de negociação, o que importa para relatórios regulatórios e gerenciais.

Nenhuma das duas substitui a Manager API ou a Web API. Um CRM que precisa abrir contas nunca vai usar a Gateway API, e uma conexão de liquidez nunca vai ser construída sobre a Web API.

O que as corretoras automatizam com a Manager API?

As corretoras usam a Manager API principalmente para tarefas que a própria equipe faria à mão no terminal Manager, em escala ou 24 horas por dia. Exemplos comuns dos projetos que vimos:

• Administração de contas — criar contas em lote, mudar clientes de grupo, alterar a alavancagem depois de uma avaliação de adequação.
• Operações de saldo — lançar depósitos, saques, crédito e correções a partir de uma fila de pagamentos aprovados.
• Ferramentas de dealing e risco — telas próprias de exposição líquida por símbolo, alertas de posições grandes e lucratividade por cliente.
• Relatórios de introducing brokers — extrair os negócios para o cálculo de comissões ao fim de cada dia.
• Verificações de compliance — sinalizar contas que operam fora do padrão esperado ou mantêm posições no fim de semana.
• Manutenção — arquivar contas inativas, limpar grupos de teste, conferir as configurações dos símbolos com uma lista mestre.

Exemplo prático: da aprovação do KYC à primeira operação

Suponha que uma corretora aprove um novo cliente no CRM às 10h de uma terça-feira. Veja como o trabalho se divide entre as interfaces em uma integração típica; em um CRM web, como o nosso, as chamadas de nível manager normalmente passam pela Web API.

1. KYC aprovadoO responsável de compliance aprova os documentos no CRM. O CRM verifica o país do cliente e atribui o grupo MT5 correto.
2. Conta criadaO CRM chama o servidor como manager para criar a conta com nome, grupo, alavancagem e uma senha gerada e, em seguida, mostra o login na área do cliente.
3. Depósito creditadoO provedor de pagamentos confirma um depósito com cartão. Depois das verificações do próprio CRM, uma operação de saldo é lançada na conta, com a referência do pagamento no comentário.
4. Cliente operaO cliente entra no WebTrader ou no app e abre uma posição. Um plugin da Server API, se a corretora tiver um, pode aplicar regras próprias nesse momento.
5. RelatóriosDurante a noite, uma rotina de relatórios lê os negócios do dia para as comissões de IB e para o painel da equipe de risco.

Quando a Web API é uma escolha melhor que a Manager API?

A Web API costuma ser a melhor escolha quando quem a consome é um serviço web rodando em Linux, na nuvem ou em uma linguagem que não seja C++ ou .NET. Ela fala HTTPS e JSON, então um CRM escrito em PHP, Node.js, Go ou Python pode usá-la sem biblioteca nativa. É por isso que a maioria dos CRMs e portais, incluindo o nosso, é construída sobre ela.

A Manager API se justifica quando você está criando uma ferramenta desktop para dealers, precisa de todo o conjunto de funções de manager em uma aplicação nativa ou quer reagir a eventos do servidor sem polling. Um monitor de risco que precisa mostrar a exposição mudando em tempo real é um caso típico. Nosso guia da Web API do MetaTrader 5 explica os limites da Web API com mais detalhes.

O que é um plugin da MT5 Server API e quando você precisa de um?

Um plugin da Server API é um código que roda dentro do servidor de negociação ou de histórico do MetaTrader 5 e é chamado à medida que os eventos acontecem — uma solicitação de operação, um negócio, uma alteração em uma conta. Você precisa de um quando uma regra tem de ser aplicada em toda operação, antes de o resultado ser definitivo, e não pode esperar que um programa externo perceba.

Exemplos incluem verificações próprias de margem ou de exposição, regras de bônus que dependem do volume negociado, lógica de copy trading que precisa reagir na hora ou dados extras gravados nos negócios para relatórios. O poder também é o risco: um plugin lento ou com defeito deixa o servidor lento ou o derruba para todo mundo. Recomendamos aos clientes manter os plugins pequenos, testá-los em um servidor separado com carga realista e deixar fora do servidor tudo o que puder rodar fora dele.

Qual API do MT5 usar em cada tarefa da corretora?

Escolha a interface pela tarefa, e não pela que o seu desenvolvedor já conhece. A tabela mostra como faríamos cada item hoje.

Quem pode ter acesso à MT5 Manager API?

O acesso vem do dono do servidor MT5, porque toda conta de manager é criada nesse servidor. Com sua própria licença MT5, você decide quem recebe qual manager e quais pacotes para desenvolvedores usa. Em um white label, quem decide é o titular da licença, e o manager que você recebe normalmente fica limitado aos seus grupos. Em um grey label de MT5, em geral você trabalha pelo CRM e pelos front ends do provedor, sem credenciais de manager próprias.

Essa é uma das questões a resolver antes de assinar. Se os seus planos incluem uma ferramenta de dealing própria ou um CRM interno, pergunte ao provedor, por escrito, qual nível de acesso à API você terá e em quais condições. Somos independentes e não temos vínculo com a MetaQuotes; para questões de licença sobre os próprios pacotes de API, o contato certo é a MetaQuotes ou o provedor do seu servidor. Se você vai pedir sua própria licença MT5, cuidamos dos requisitos e do pedido junto à MetaQuotes como serviço de consultoria, mediante remuneração.

Não sabe o que pedir? Mande uma mensagem pelo WhatsApp descrevendo sua estrutura e sugerimos a redação.

E os serviços de “API MT5” de terceiros?

Muitos produtos vendidos como “API MT5” não são APIs da MetaQuotes para corretoras. Alguns se conectam a contas de negociação individuais rodando terminais na nuvem do fornecedor; outros encapsulam o pacote Python da MetaQuotes, que conversa com um terminal desktop na mesma máquina. Eles servem para traders, serviços de sinais e análises, e funcionam com contas de qualquer corretora.

Outros são wrappers hospedados sobre a Manager API ou a Web API, que oferecem uma interface REST em cima de uma conexão de manager. Podem poupar tempo de desenvolvimento, mas suas credenciais de manager passam a ficar com um terceiro, e você depende da disponibilidade dele e do ciclo de atualização dele quando a MetaQuotes lança uma nova build. Pergunte onde o serviço fica hospedado, quem pode ver as credenciais e o que acontece com a sua integração se o fornecedor encerrar as atividades.

Como manter segura uma integração de nível manager?

Trate toda conta de manager usada por um software como uma conta de sistema privilegiada, porque é isso que ela é. As regras que aplicamos nas nossas integrações:

• Um manager por integração, só com os direitos e grupos de que essa integração precisa.
• Operações de saldo apenas a partir de uma fila aprovada, nunca diretamente de uma requisição vinda do cliente.
• Credenciais em um cofre de segredos, trocadas quando mudam funcionários ou fornecedores.
• Conexão permitida apenas a partir de servidores conhecidos.
• Toda gravação registrada com o motivo de negócio e conciliada diariamente.
• Nada de repetir automaticamente movimentações de dinheiro ou operações após um timeout; verifique antes o estado no servidor.

Quais são os erros comuns em projetos com a MT5 Manager API?

Os erros comuns são de arquitetura, e a maioria acontece na primeira semana. Evitá-los custa pouco; corrigi-los depois que os clientes dependem do sistema custa caro.

• Um manager para tudo. O CRM, a rotina de relatórios e a ferramenta do dealer compartilham um login com todos os direitos, então ninguém consegue saber qual sistema fez uma alteração e nenhum deles pode ser revogado separadamente.
• Consultar conta por conta. Um portal que pede as posições de cada cliente, uma de cada vez, funciona com 50 contas e deixa o servidor lento com 5.000. Use requisições em lote e guarde em cache o que não muda.
• Lógica de negócio em plugin. Uma regra de copy trading ou de bônus escrita como plugin da Server API porque parecia “mais perto do servidor”, quando poderia rodar com segurança fora dele.
• Ignorar o horário do servidor. Negócios gravados no CRM no horário do servidor e comparados com registros de pagamento em UTC, de modo que as conciliações diárias ficam defasadas em duas ou três horas.
• Repetir movimentações de dinheiro. Uma chamada de depósito dá timeout, o código tenta de novo e o cliente é creditado duas vezes. Verifique o histórico da conta antes de qualquer nova tentativa.
• Nenhum plano para as atualizações do MT5. A MetaQuotes lança novas builds com regularidade. Mantenha um servidor de teste na próxima build e rode sua integração nele antes de o servidor de produção ser atualizado.

Um projeto de prop firm ou de copy trading muda a escolha?

Sim, um pouco. A tecnologia para mesas proprietárias depende muito de ações rápidas e baseadas em regras sobre as contas — encerrar uma conta de avaliação no instante em que um limite de drawdown é rompido, por exemplo. Algumas empresas fazem isso de fora, pela Web API ou pela Manager API, com verificações frequentes; outras preferem um plugin, para que a regra seja aplicada dentro do servidor. A troca é entre tempo de reação e o risco de rodar código próprio no servidor.

Copy trading e PAMM ficam em uma situação parecida. A cópia em si pode rodar fora do servidor, mas a alocação de volume e de taxas precisa ser exata, então a interface escolhida tem de fornecer dados confiáveis dos negócios e um meio de conciliar. A liquidez é outra questão: se o projeto também precisa de novos provedores, veja a integração com provedores de liquidez.

Como a FXUP trabalha com as APIs do MT5?

Nosso WebTrader com a sua marca, os apps mobile e o nosso próprio CRM para corretoras se conectam ao MT5 por um back end em Go que usa a Web API. Também trabalhamos com CRMs parceiros e propomos o que fizer mais sentido para o projeto; em qualquer caso, verificamos qual interface e quais direitos de manager o CRM precisa antes de qualquer coisa entrar no ar. Para clientes com servidor próprio, também definimos o escopo de ferramentas para dealers, rotinas de relatórios e, de vez em quando, um plugin, e avisamos quando um recurso que o MT5 já tem ou uma interface mais simples resolveria o problema.

Se você está comparando orçamentos para um projeto de API, mande a especificação pelo WhatsApp; podemos dizer qual interface cada item exige e onde está o trabalho escondido. Nossa página de integrações sob medida lista os tipos de projeto que assumimos.

Perguntas frequentes

Não encontrou sua pergunta? Pergunte pelo WhatsApp, mande mensagem para @FXUPCK no Telegram ou escreva para [email protected].