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
• In-app actions for deposits, withdrawals and KYC processes
• Partner attribution and trader management workflows

The components can be deployed independently or together as a comprehensive suite.

Notes

1. 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 Customer Success Team.
2. 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.

Business value

Full integration gives brokers control over the user experience at the points where broker and cTrader systems meet:

• Broker-owned identity: with SSO, the broker CRM becomes the identity provider. User creation, login and session management are the broker's responsibility; cTrader defers to the broker backend.
• Embedded cashier and compliance: deposit, withdrawal and KYC flows run inside cTrader rather than requiring traders to navigate to a separate client area. The broker retains ownership of the transaction logic and compliance data.
• In-platform messaging: In-app ribbons allows the broker to surface targeted messages inside cTrader, with user-level personalisation available when SSO is in use.
• Partner attribution: cTrader Invite integrates referral and IB tracking directly into the cTrader platform, linking affiliate activity to the broker's partner programme.
• Full platform embedding: Embedded cTrader web runs the entire cTrader trading interface inside the broker's client area, keeping traders within the broker's branded environment.
• Incremental adoption: modules can be deployed individually or in combination; a broker may start with a minimal one-time token setup and migrate to full SSO without redeploying existing feature modules.

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
• In-app deposit/withdrawal: Deposit and withdrawal screens embedded within cTrader
• In-app KYC: KYC verification screens embedded within cTrader
• In-app generic action/chat: Custom actions and support chat within cTrader
• In-app ribbons: Targeted ribbons and promotional elements
• cTrader Invite: Multi-level IB and referral tracking

Core architecture

The SSO solution operates on a token-based authentication model with bidirectional API communication:

1. Broker to cTrader: Manager token authentication for backend operations
2. cTrader to broker: CRM API token authentication for user-facing actions
3. User flows: OAuth 2.0 compliant authentication sequences
4. In-app integration: One-time token (OT) system for embedded actions

warning

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, consult this video.