Solution overview
This documentation provides technical specifications, API references, conformance tests, and process diagrams for implementing Spotware's Full Integration.
Purpose
Spotware's Full Integration is a modular set of APIs and integration components that connects broker CRM systems with cTrader. It enables:
- Single sign-on capabilities between broker CRM systems and cTrader platforms
- InApp controls for actions like deposits, withdrawals, and KYC processes
- Partner attribution and trader management workflows
The components can be deployed independently or together as a comprehensive suite.
The Full Integration is a paid add-on and is not provided by default as part of the onboarding package. To proceed with integration and access additional information, contact Spotware's account management team.
The SSO API is not a replacement for the WebServices API, and vice versa. Instead, the SSO API is complementary to all other APIs offered by Spotware. You do not lose access to the functionalities of the WebServices API by integrating with the SSO API.
Key Components
Identity Modules
- SSO User creation and authorisation: Complete OAuth implementation with broker-owned identity management
- One-time token handoff: Minimal one-time token approach for simple integrations
Feature Modules
- Embedded cTrader Web: Full trading platform integration within broker client areas
- InApp Actions: Deposit, withdrawal, KYC, and custom actions within cTrader
- InApp Controls: Targeted ribbons and promotional elements
- Partner Attribution: Multi-level IB and referral tracking
Business value
- Single sign-on eliminates duplicate login steps for traders moving between a broker CRM and cTrader
- In-app cashier embeds deposit, withdrawal, and KYC screens inside the platform, removing browser redirects
- Partner attribution links referred traders to specific introducing brokers at the user or account level
- The modular structure lets brokers implement only the components their compliance and product requirements need
Core Architecture
The SSO solution operates on a token-based authentication model with bidirectional API communication:
- Broker to cTrader: Manager token authentication for backend operations
- cTrader to Broker: CRM API token authentication for user-facing actions
- User Flows: OAuth 2.0 compliant authentication sequences
- InApp Integration: One-time token (OT) system for embedded actions
The SSO (OAuth) flow gives traders the opportunity to perform deposits/withdrawals inside the platform. Note this is done by displaying an interactive deposit/withdrawal screen entirely hosted inside your client area. cTrader itself is not a payment processor; all deposit/withdrawal requests and resolutions would need to be handled by your usual service provider.
For a detailed look at Full Integration, you can consult this video.