Reporting API

Our Reporting API is a powerful solution for anyone who wants to integrate their existing reporting systems with the cTrader backend. Alternatively, you may use it to create a custom reporting suite that displays data about cTrader accounts and their operations.

Sobre a Reporting API

A Reporting API fornece uma vista em tempo real dos principais eventos que ocorrem no ecossistema cTrader. A API também possui um mecanismo para recuperar dados anteriores caso alguma mensagem em tempo real seja perdida.

Eventos

Após uma integração bem-sucedida, deverá começar a receber mensagens especiais contendo dados sobre novas ordens, transações, posições e (opcionalmente) alterações nos preços dos instrumentos de negociação. Pode utilizar os dados destas mensagens para qualquer número de finalidades, incluindo gestão de risco, avaliação de desempenho e planeamento estratégico.

Snapshots

Ao enviar um simples pedido web, pode solicitar um "snapshot" de todas as entidades do servidor de um tipo específico e os seus detalhes. Pode utilizar esta informação para reconciliar facilmente o seu sistema de relatórios com o estado do backend do cTrader.

Funcionamento da Reporting API

Para enviar eventos em tempo real para o seu sistema de relatórios, a Reporting API depende do RabbitMQ, um conhecido software de intermediação de mensagens. Conectar-se ao nosso nó RabbitMQ é fácil, pois só precisa de executar três ações principais.

  • Colocar o seu IP na lista branca, contactando a equipa de garantia de serviço da Spotware
  • Receber credenciais apenas de leitura para o RabbitMQ
  • Utilizando um cliente RabbitMQ para a sua linguagem de programação preferida, inicializar uma conexão com a nossa instalação do RabbitMQ

Depois disso, deverá começar a receber mensagens de eventos que pode gerir, utilizando qualquer lógica adequada.

Tenha em atenção que os únicos pré-requisitos para a integração com a Reporting API consistem em colocar os seus IP na lista branca e receber todas as credenciais necessárias para o nosso nó RabbitMQ. Tal torna o processo de integração muito rápido de completar, permitindo-lhe manter-se informado sobre todas as principais atividades de negociação quase imediatamente após obter acesso ao backend do cTrader.

Principais benefícios da Reporting API

Tal como qualquer outro produto da Spotware, a Reporting API oferece vários benefícios importantes aos utilizadores.

Rapidez e eficiência

A Reporting API utiliza Google Protobufs leves para enviar mensagens de eventos em tempo real, reduzindo as cargas de conexão.

Fiabilidade superior

A obtenção de um "snapshot" para reconciliação com o backend do cTrader pode ser conseguida através de um simples pedido web, garantindo que nunca perde dados importantes.

Facilidade de integração

Uma vez que a Reporting API depende do RabbitMQ, pode utilizar qualquer cliente RabbitMQ existente para reduzir ao mínimo o tempo de integração.

Facilidade de manutenção

Uma vez que cada evento de mensagem tem um número de sequência único, é fácil determinar se é necessária reconciliação em qualquer momento.

Documentação

O Centro de Documentação da Spotware contém documentação extensa sobre como pode efetuar a integração com a Reporting API. A documentação também detalha como pode realizar pedidos web para fazer "snapshots" e quando exatamente deve iniciar a reconciliação com o backend do cTrader.

Tal como acontece com outras API da Spotware, a documentação da Reporting API é regularmente atualizada para refletir todas as últimas alterações e melhorias.