Skip to main content

0.1 Purpose & Scope

This documentation defines the API calls made when working with Spotware's broker SSO (OAuth) flows and InApp controls. The documentation also contains essential provisions for integration including conformance tests and process diagrams.

Purpose​

The purpose of this document is to provide comprehensive technical specifications for implementing broker SSO (OAuth) integration with cTrader. This integration enables:

  • Single sign-on capabilities between broker CRM systems and cTrader platforms
  • Seamless user experience across broker client areas and trading terminals
  • InApp controls for actions like deposits, withdrawals, and KYC processes
  • Partner attribution and trader management workflows

Scope​

This document covers:

  • Identity Management: User creation, authentication, and authorization flows
  • Feature Modules: Embedded cTrader Web, InApp actions, controls, and partner systems
  • Technical Implementation: API specifications, authentication mechanisms, and error handling
  • Compliance: Conformance testing, security requirements, and operational guidelines

Limitations​

The following are explicitly out of scope:

  • Core WebServices API documentation (complementary, not replacement)
  • Payment processing implementations (broker responsibility)
  • CRM system design and architecture (broker-specific)
  • Custom UI/UX design requirements beyond basic guidelines
info

Note that the SSO (OAuth) solution is a paid add-on. It 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.

info

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.