Integração e API
De uma incorporação iframe de 30 minutos a uma implementação totalmente personalizada em REST + gRPC. A plataforma continua a ser a fonte de verdade — controla a UX, a marca e o funil.
Demonstração ao vivo · sem código
Sem alterações de backend, migração ou reformulação. Assine um JWT de curta duração, incorpore o snippet abaixo no seu portal de cliente — os seus investidores entram numa experiência B2COPY totalmente personalizada sem um segundo login.
Copie o snippet do iframe e cole em qualquer página do portal — leaderboard, perfil do master, fluxo de assinatura, tudo mobile-ready.
Emita um JWT externo a partir do seu IdP e troque-o via SideAuthenticate. Os seus clientes nunca veem um login B2COPY separado.
Herda as suas cores, tipografia e idioma através de parâmetros de consulta e tokens CSS — pronto a usar.
Um contrato
Cada método público é descrito em ficheiros `.proto` partilhados e exposto em gRPC e REST. Escolha o transporte adequado à sua stack — as estruturas de pedido e resposta são idênticas.
Rotas versionadas geradas a partir dos mesmos ficheiros .proto. Utilize-as para CRMs, aplicações web, clientes móveis e cenários no-code — onde quer que HTTPS seja mais simples do que gRPC.
Utilize Connect ou gRPC-Web para microsserviços, gateways internos e integrações de elevado débito onde a latência e o streaming são importantes. Clientes type-safe gerados por código em qualquer linguagem.
Superfícies de API
Três camadas leves, um contrato protobuf. Utilize-as de forma independente ou em conjunto — Broker para back office, Frontend para a sua aplicação cliente, Widget para incorporações no seu site de marketing.
Servidor para servidor. Criado para o seu CRM e back office — JWT de administrador, listas paginadas de contas com dados de titulares incorporados, gestão completa de subscrições para links de copier e PAMM.
Servidor para servidorEm nome do utilizador. Alimenta a sua própria aplicação web ou móvel: autenticação, contas, subscrições, operações, taxas, transferências, ranking, gráficos, definições de UI — tudo, desde o login até ao encerramento de uma posição.
No âmbito do utilizadorSuperfície pública de leitura. Uma camada simplificada para blocos incorporáveis — cartões de master, gráficos, rankings e verificações de código de subscrição no seu site de marketing, sem uma aplicação cliente completa.
Público · só leituraAuthentication
Tokens assinados por EC, com âmbito por tenant e rotação independente das sessões de utilizador. Sem gestão de palavras-passe em nenhum lado da integração.
Os seus serviços de back office autenticam-se na API Broker com um JWT de administrador assinado pela sua chave EC. Os tokens têm âmbito por tenant e podem ser rodados sem afetar sessões de utilizador.
Broker APIEmita um JWT externo a partir do seu portal de cliente, troque-o através de SideAuthenticate ou AuthUserWithExternalToken e prossiga com chamadas normais no âmbito do utilizador. Sem segundo login para os seus clientes.
API FrontendPrimeiros passos
Um cenário demora 1–3 dias de desenvolvimento de ponta a ponta. Duas primeiras integrações típicas: um ranking no seu site (API Widget) ou sincronização de subscrições com CRM (API Broker).
01
Obtenha credenciais de staging e produção — JWT de administrador para a API Broker, configuração SSO para a API Frontend. Provisionadas num dia útil.
02
Escolha gRPC (Connect ou gRPC-Web) ou REST. A spec OpenAPI é gerada a partir dos mesmos arquivos .proto — escolha o que combina com seu stack.
03
Um leaderboard no seu site (LeaderboardList + ChartService) ou sincronização de assinaturas com o CRM (Broker LinkService). Um cenário leva de 1 a 3 dias.
04
Encadeie SideAuthenticate → Frontend API com o JWT do usuário. Seus clientes saem do portal e entram na experiência B2COPY sem reautenticar.
Três caminhos de integração
Cada percurso é documentado, suportado e utilizado em produção por outras corretoras. Comece hoje com o widget e adicione APIs mais profundas depois — nada na sua stack precisa de mudar.
Caminho mais rápido
Incorpore um widget pré-configurado (ranking, perfil de master, fluxo de subscrição) no seu CRM, área de cliente ou página de marketing. SSO através de um JWT assinado — os seus investidores entram no B2COPY já autenticados e com a sua marca.
Em produção em 30 minutos
<!-- Add to your client portal -->
<iframe
src="https://widget.b2copy.com/copy"
data-sso-token="{{user.jwt}}"
data-theme="dark">
</iframe>
B2Core
+ IB Module
Nullpoint CRM
Ready
FX Back Office
ReadySem desenvolvimento
Já usa B2Core, Nullpoint ou FX Back Office? O B2COPY está pronto — ative o recurso e o copy trading aparece na área do cliente no mesmo dia. A integração com B2Core também libera o IB Module para programas de parceiros.
Controlo total
Crie seu próprio UX de copy trading do zero. REST para CRMs, web, mobile e no-code; gRPC para streaming em tempo real de alta performance. Gerado a partir dos mesmos contratos protobuf — a semântica é idêntica entre transports. Sandbox + engenheiro de integração dedicado incluídos.
2–3 semanas · sandbox + engenheiro// REST APIGET/api/v1/copy/mastersPOST/api/v1/copy/subscriptionsGET/api/v1/copy/positionsPUT/api/v1/copy/subscriptions/{id}Visão geral da cobertura
Use-o como referência de dimensionamento: a sua equipa de CRM trabalha com a API Broker, a sua aplicação cliente com a API Frontend e o seu site de marketing com a API Widget.
| Feature | Broker API Servidor para servidor | API Frontend Em nome do utilizador | API Widget Público · só leitura |
|---|---|---|---|
| Contas e usuários | Leituras · listas paginadas | CRUD completo + ranking | Leituras · código de subscrição |
| Assinaturas Copier / PAMM | Gestão completa | Gestão completa | — |
| Trading e histórico | — | Posições · operações · estatísticas | Posições · estatísticas |
| Rentabilidade e gráficos | — | ✓ | ✓ |
| Taxas e códigos promocionais | — | ✓ | Plano ativo |
| Transferências | — | ✓ | — |
| Desafios e contests | — | ✓ | — |
| Auth / SSO | — | ✓ | — |
| Definições de UI e plataforma | — | ✓ | Ao nível da plataforma |
Broker API
Gestão de subscrições e leituras de listas adequadas a CRM, com dados de titulares incorporados nas respostas. Autentica com um JWT de administrador assinado pela sua chave EC.
Métodos representativos de que a maioria dos CRMs precisa no primeiro dia — a superfície completa da API Broker é mais ampla e é expandida mediante pedido para corresponder ao seu modelo de back office.
Uma chamada devolve uma lista paginada de contas de trading com filtros, ordenação e dados básicos do titular associados (id, e-mail, alcunha, país) — criada para vistas de listas de CRM.
| Method | Purpose |
|---|---|
Listar | Lista paginada de contas de trading com filtros, ordenação e dados do titular incorporados — para apresentação única no CRM. |
| Method | Purpose |
|---|---|
Obter | Obtenha um perfil de utilizador B2COPY. |
Listar | Lista paginada de utilizadores. |
Superfície de gestão completa para subscrições de copier e PAMM — criar, atualizar, eliminar, restaurar, obter detalhes e listar com filtros.
| Method | Purpose |
|---|---|
CreateCopierLink | Crie uma subscrição de Copy Trading (investidor → master). |
CreatePAMMLink | Crie uma subscrição PAMM. |
UpdateCopierSettings | Atualize as definições de cópia. |
UpdatePAMMSettings | Atualize as definições PAMM. |
Eliminar | Desative uma subscrição. |
Restaurar | Restaure uma subscrição previamente desativada. |
GetCopierLink / GetPAMMLink | Detalhes de uma única subscrição. |
ListCopier / ListPAMM | Liste subscrições com filtros e paginação. |
Cenários típicos: sincronizar subscrições com o CRM, executar operações em massa a partir de ferramentas de suporte, orquestrar o onboarding de masters / investidores do lado da corretora. Precisa de um método não listado — reatribuição em massa, formato personalizado de dados do titular, endpoint para ferramentas internas? Diga-nos durante o levantamento; adicionamo-lo na próxima versão.
API Frontend
Tudo, desde o login até ao encerramento de uma posição e ao pagamento de taxas. Use-o para substituir ou complementar a aplicação cliente B2COPY padrão — funciona em web e mobile e autentica o utilizador por SSO com um JWT de curta duração.
Uma fatia representativa da Frontend API — a superfície real cobre muito mais serviços, campos e edge cases. Estendemos sob demanda para combinar com o UX do seu app cliente.
| Method | Purpose |
|---|---|
Login | Inicie sessão com o nome de utilizador / palavra-passe da plataforma. |
AuthWithPlatformCredentials | Autenticar com credenciais da conta de trading. |
RefreshToken | Atualize a sessão ativa. |
AuthUserWithExternalToken / AuthAccountWithExternalToken | SSO através de tokens externos — incorpore o B2COPY na sua área de cliente sem um segundo login. |
SideAuthenticate / SideLoginWithToken | Login lateral integrado a partir do seu portal de corretora. |
O serviço mais abrangente da API — cobre o ciclo de vida de contas, ranking público, perfis de master, finanças, códigos de subscrição e gestão de tipos de conta.
| Method | Purpose |
|---|---|
Criar | Crie uma conta B2COPY sobre uma conta MT ou cTrader existente. |
Obter / atualizar | Leia e edite dados da conta. |
LeaderboardList | O ranking público de masters — filtros, ordenação e feed top-N. |
ListMyAccounts | Liste as contas pertencentes ao utilizador atual. |
ListAccountFinances | Métricas financeiras por conta. |
SetIsInLeaderboard | Alterne se um master aparece no ranking. |
CheckSubscriptionCode / GenerateSubscriptionCode / SetSubscriptionCode | Códigos de subscrição para masters fechados (apenas por convite). |
GetMasterByLogin | Procure um master pelo login. |
GetAccountView / UpdateAccountView | A vista do perfil público do master. |
SetMinimumDeposit | Depósito mínimo exigido aos subscritores. |
ResetPassword | Reponha a palavra-passe da conta. |
ListAvailableAccountTypes | Tipos de conta disponíveis na plataforma. |
| Method | Purpose |
|---|---|
CreateCopierLink / CreatePAMMLink | Crie uma subscrição em nome do utilizador. |
UpdateCopierSettings | Atualize as definições de cópia. |
Eliminar / restaurar | Cancele a subscrição e restaure. |
ListSubscribersCopier / ListSubscriptionsCopier | Assinantes e assinaturas Copier. |
ListSubscribersPAMM / ListSubscriptionsPAMM | Subscritores e subscrições PAMM. |
GetOverviewMaster / GetOverviewInvestor | Vista resumida para a função de master ou investidor. |
| Serviço · Método | Purpose |
|---|---|
PositionService.List / Close / Detach | Posições abertas, encerramento e desvinculação de um master. |
DealService.List | Histórico de operações. |
StatService.GetTradingStatistics | Estatísticas de trading agregadas para dashboards e relatórios. |
| Serviço · Método | Purpose |
|---|---|
ReturnsService.List | Rendimentos ao longo de períodos. |
ProfitabilityService.GetPnlsByLinks | P&L por subscrição. |
ChartService.Get / List | Gráficos de rentabilidade para cartões de master. |
| Serviço · Método | Purpose |
|---|---|
PlanService | Criar / obter planos de taxas, obter o plano ativo, obter um plano por código promocional. |
PromoCodeService | Criar, atualizar, eliminar e listar códigos promocionais. |
JobService | Liste trabalhos de taxas e taxas pagas por investidor. |
CommissionSharingService | Partilha de receita com parceiros — guarde e leia a configuração de partilha de comissões. |
| Method | Purpose |
|---|---|
Criar | Transfira entre contas. |
ListTransfers | Histórico de transferências. |
ListMasterFees / ListInvestorFees | Taxas associadas a transferências. |
Cancel | Cancelar uma transferência. |
CanTransfer | Verificar se uma transferência é possível. |
| Serviço · Método | Purpose |
|---|---|
SettingsService.GetSettings / SetSettings | Definições da conta PAMM. |
RolloverService.Start | Acione o rollover. |
BalanceOperationService.List / SetCancelled (v2) | Operações de saldo PAMM. |
| Serviço · Método | Purpose |
|---|---|
ChallengeService.List | Liste desafios ativos — base para campanhas promocionais e gamificação. |
PersonalChallengeService | Participação do utilizador e progresso pessoal (criar, obter progresso, listar). |
StatisticsService.GetDailySummary | Resumo diário para rankings de concursos. |
| Serviço · Método | Purpose |
|---|---|
RiskLimitService.SetLossLimit | Limite de perda por subscrição. |
RatioService.Get | Rácios de símbolos. |
TenantService.ListAllAvailable | Ambientes e tenants disponíveis. |
CommonSettingsService.GetPlatformSettings | Definições globais da plataforma. |
MenuSettingsService.GetMenus | Estrutura do menu do app. |
AccountSettingsService.ListBatch | Definições de UI por conta (incluindo acesso não autenticado). |
UserService.GetCurrentUser / Update | Perfil do utilizador atual. |
ProductService | Produtos e moedas para criação de contas. |
CountryService.List | Referência de país. |
UploadService — GeneratePresignURL / ConfirmUpload / GetUpload | Avatares e mídia via S3 presign. |
API Widget
Uma camada pública enxuta para quando você não precisa de um app cliente completo — exibir o leaderboard, renderizar um card de master ou validar um código de assinatura no site de marketing. O mesmo contrato protobuf, menos superfície.
Visão geral dos domínios públicos de leitura utilizados pelo widget incorporado — o número real de métodos é maior e abrimos endpoints de leitura adicionais mediante pedido para incorporações personalizadas.
| Domínio · Métodos | Purpose |
|---|---|
Accounts — Get, List, CheckSubscriptionCode | Cartão de master, lista de ranking para o widget, verificação de código de subscrição. |
Profitability — ReturnsService.List, ChartService.Get / List | Mini gráficos e rendimentos na página. |
Statistics — StatService.GetTradingStatistics | Métricas principais no widget. |
Positions — PositionService.List | Operações abertas (leitura pública). |
Fees — PlanService.GetActive, GetByPromoCode | Plano ativo para o widget de assinatura. |
UI — CommonSettingsService.GetPlatformSettings | Branding e configurações da plataforma dentro do widget. |
As três superfícies de API estão descritas em arquivos `.proto` compartilhados (proto/b2copy/broker, /frontend, /widget) e expostas via gRPC e REST — gere clients em qualquer linguagem a partir do mesmo contrato. A lista completa de métodos por superfície é bem maior que os exemplos acima; a referência completa está na documentação da API e é estendida sob demanda.
Suporte prático à integração
Os métodos indicados acima são uma seleção — a API real é muito mais ampla e expandimo-la mediante pedido para se adequar ao seu CRM, área de cliente e modelo de reporting. Um engenheiro B2COPY dedicado acompanha desde a primeira chamada sandbox até à primeira cópia em produção, para que a corretora obtenha uma integração limpa e ajustada, e não apenas um ficheiro `.proto` e votos de boa sorte.
As tabelas nesta página listam cerca de 30% representativos da superfície da API — métodos a que a maioria das corretoras recorre na primeira integração. O contrato proto completo é significativamente maior nas APIs Broker, Frontend e Widget. Se o método de que precisa não está na página, quase certamente já existe — e, se não existir, adicionamo-lo.
Designado do kickoff ao go-live. Analisa seu data flow, recomenda as cadeias de métodos mais limpas para o seu cenário e permanece disponível para integrações seguintes.
Precisa de um método que não está listado? De um novo campo numa resposta existente? De um modo em massa para um endpoint de ferramentas internas? Adicionamo-lo na próxima versão — normalmente em dias, não trimestres.
Ambiente de staging completo com masters, investidores e subscrições de exemplo, além de um canal privado no Slack / Teams com a equipa de engenharia para comunicação rápida durante a implementação.
Analisamos em conjunto os seus endpoints, configuração JWT, paginação e gestão de limites antes de entrar em produção. Deteta casos extremos antes de se tornarem pedidos de suporte.
Fale-nos sobre o seu CRM, portal de cliente e modelo de reporting — mapearemos o caminho de integração e mostraremos quais métodos utilizar (e quais expandir).
Perguntas frequentes
Não. As tabelas acima mostram uma seleção representativa de métodos — aproximadamente a parte que a maioria das corretoras utiliza na primeira integração. A API real é significativamente mais ampla nas três superfícies (Broker / Frontend / Widget). A referência completa e atualizada está na documentação da API em docs.b2copy.b2broker.com.
Sim. Se o método, campo de resposta, filtro ou modo em massa de que precisa não estiver no contrato atual, adicionamo-lo. Praticamente todas as corretoras que integramos recebem pelo menos uma extensão personalizada durante a integração — o prazo típico é de dias até uma única versão, não trimestres. Diga-nos o cenário durante o levantamento e estará no sandbox antes de escrever código cliente para o utilizar.
Recebe um engenheiro de integração B2COPY dedicado desde o início até à entrada em produção, um sandbox completo com masters / investidores / subscrições de exemplo, um canal privado Slack ou Teams com a equipa de engenharia para comunicação rápida e uma revisão conjunta de pré-produção dos seus endpoints, configuração JWT e paginação antes da publicação. O objetivo é uma integração adequada à sua stack, não uma solução genérica de copiar e colar.
Para o caminho widget + SSO — não. Um administrador de back office pode copiar o snippet do iframe e assinar JWTs através do painel de administração. Para conectores CRM pré-configurados (B2Core, Nullpoint, FXBO), é uma opção de funcionalidade. Integrações REST + gRPC mais profundas normalmente exigem 1–3 dias de um programador de backend por cenário.
Incorpore o widget iframe em 30 minutos — no mesmo dia com SSO. A ativação de CRM pré-configurado (B2Core / Nullpoint / FX Back Office) também é no mesmo dia. Implementações REST + gRPC totalmente personalizadas demoram 2–3 semanas de ponta a ponta, com sandbox e um engenheiro de integração B2COPY dedicado.
Sim. Cada método público é descrito em ficheiros .proto partilhados (proto/b2copy/broker, .../frontend, .../widget). As rotas REST e a especificação OpenAPI são geradas a partir dos mesmos ficheiros — a semântica de pedidos e respostas é idêntica; basta escolher o transporte adequado à sua stack.
Dois fluxos distintos. Servidor para servidor: um JWT de administrador assinado pela sua chave EC, com âmbito por tenant — utilizado na API Broker. Sessão de utilizador: emita um JWT externo do seu portal de cliente, troque-o via SideAuthenticate (ou AuthUserWithExternalToken) e chame a API Frontend no âmbito do utilizador. Sem gestão de palavras-passe em nenhum lado.
Mais de 150 configurações do painel admin cobrem a maior parte do B2COPY antes de ser preciso desenvolver: colunas do leaderboard, visibilidade de estatísticas, seis tipos de taxas e suas fórmulas, limites de risco controlados pelo broker para masters, padrões de visibilidade de contas, mapeamento de símbolos e branding completo (cores, logos, temas).
Explore more
Taxas de performance, gestão, subscrição, volume, adesão e lucro.
Saiba maisLimites diários, controlos de drawdown máximo e limites de perda pessoais.
Saiba maisSeis métodos de alocação — proporcional, multiplicador de rácio ou lote fixo.
Saiba maisCopie trades entre servidores MT4, MT5, cTrader e B2Trader.
Saiba maisSSO Widget, integrações CRM, APIs REST e gRPC.
Saiba maisAnalisaremos o seu CRM, área de cliente e back office e proporemos o caminho de integração adequado à sua capacidade de engenharia — widget hoje, API completa em três semanas.
