FTG Platform API Documentation

Interactive documentation for the Fast Transaction Gaming transaction & analytics servers

PRE-RELEASE — This documentation is confidential and intended for authorised recipients only. Do not distribute.
3
Services
73
Total Endpoints
25
Shooter Endpoints
20
Jeeves Endpoints
28
Portal Endpoints
125
Schema Definitions

Quick Start

The FTG platform consists of three backend services that together manage all game transactions, player accounts, blockchain operations, analytics, and portal administration. Click a tab above to explore each API interactively using Stoplight Elements.

FTG Shooter -- Game Transaction Server

The primary game server handling player management, token operations, blockchain integration, game rooms, sessions, and administrative functions.

25 Endpoints 50 Schemas

FTG Jeeves -- Statistics & Analytics Server

Analytics server providing blockchain balance tracking, token tallies, transaction history, financial analytics, and user analytics.

20 Endpoints 47 Schemas

FTG Portal -- Administration & Management API

Portal server providing authentication, game configuration, token products, wallet operations, cryptocurrency, EC2 instance management, and system operations.

28 Endpoints 45+ Schemas

Architecture Overview

+---------------------------------------------------------------------------+
|                        Game Client / Admin Dashboard                      |
+--------+---------------------------+------------------+-------------------+
         |                           |                  |
         v                           v                  v
+-------------------+     +--------------------+     +---------------------+
|   FTG Shooter     |     |   FTG Jeeves       |     |   FTG Portal        |
|   Port 5555/5556  |     |   Port 5666/5667   |     |   Port 3000+        |
|                   |     |                    |     |                     |
|  - Player mgmt   |     |  - Balance track.  |     |  - Auth & accounts  |
|  - Token ops     |     |  - Player rankings |     |  - Game management  |
|  - Blockchain    |     |  - Transaction hx  |     |  - Token products   |
|  - Game rooms    |     |  - Financial stats |     |  - Wallet ops       |
|  - Sessions      |     |  - Playground data |     |  - EC2 management   |
|  - Admin / OTP   |     |  - Exchange rates  |     |  - Access keys      |
+--------+---------+     +---------+----------+     |  - System ops       |
         |                         |                 +----------+----------+
         v                         v                            |
+---------------------------------------------------------------------------+
|                          MySQL Database                                    |
|                       (saigon / ftg-saigon)                                |
+---------------------------------------------------------------------------+
         |
         v
+---------------------------------------------------------------------------+
|                External Services                                          |
|  - Ethereum / TRON blockchains     - AWS EC2 (Portal)                     |
|  - Kraken Exchange API             - AWS S3 (File storage)                |
|  - Twilio (SMS OTP)               - SMTP (Email)                          |
+---------------------------------------------------------------------------+

Authentication

All authentication credentials are passed in the JSON request body, not in HTTP headers. The API uses several authentication patterns:

MethodField(s)How to obtainUsed by
Access Key accessKey / accesskey / access_key Issued to game clients & partners FTG-prefixed endpoints, admin ops
Session ID session_id / sessionId / SessionId POST /getsessionid (wallet) or POST /validateotp (email) Player-facing endpoints
System Token sysToken POST /syslogin Administrative / system endpoints
Ethereum Signature ethereumSignature + ethereumAccount Client wallet signs sigMessage from POST /requestlogin Wallet-based authentication
Auth Key authKey Master administrative key Jeeves analytics endpoints
IP Allow-list hostsAllow Server-side configuration Restricted admin endpoints

Global Conventions

Request Format

Response Format

Every response contains an integer status field:

{ "status": 0, ... }  // 0 = success
{ "status": 1, ... }  // 1 = failure

Pagination (Jeeves)

Paginated Jeeves endpoints use offset-based pagination with a maximum of 255 records per page:

// Request
{ "index": 0, "authKey": "..." }

// Response
{
  "status": 0,
  "fromIndex": 0,
  "totalRecords": 1524,
  "noOfRecords": 255,
  "data": [ ... ]
}

UUIDs

All UUIDs are stored as binary(20) in MySQL and transmitted as 40-character uppercase hex strings (no dashes). Example: 75AC1C7D08F15E78D447B1BF6001F2BC63043FFC

Endpoint Categories

FTG Shooter (25 endpoints)

Access Keys & Players

Access key registration, player registration via wallet or email OTP, session management.

5 endpoints

Token Operations

Token transfers between players, deposit and withdrawal processing.

3 endpoints

Transactions

Transaction listing and in-game transaction registration.

2 endpoints

Game Rooms

Room creation, joining, leaving, and result submission.

4 endpoints

Player Info

Player profile retrieval, avatar updates, level progression, online status.

4 endpoints

User Preferences & Financial

User preference management, financial limit queries, deposit and withdrawal registration, token rates.

5 endpoints

Token Products

Token product catalog queries.

2 endpoints

FTG Jeeves (20 endpoints)

Sessions

Session creation and management.

1 endpoint

Blockchain Balances

Blockchain wallet balances, daily snapshots, incoming/outgoing transactions.

4 endpoints

Credit Card

Credit card transaction statistics.

1 endpoint

Token Tally

Token supply tracking — minted, burned, gas tallies.

3 endpoints

Player Transactions

Player transaction history with alias resolution.

2 endpoints

Player Game History

Individual game session history.

1 endpoint

Financial Analytics

Balance positions, takings, withdrawals, balance spread.

4 endpoints

User Analytics

User base totals, daily active/playing/new players.

4 endpoints

FTG Portal (28 endpoints)

Games

Game listing, creation, updates, deletion, status management, game configuration.

6 endpoints

Game Tokens

Token creation, listing, updates, deletion, supply management.

5 endpoints

Game Actions

Action definitions, listing, updates, deletion.

4 endpoints

Token Products

Product catalog, creation, updates, deletion.

4 endpoints

Redemption Policies

Policy listing and creation for token redemption rules.

2 endpoints

Wallets

Wallet listing and balance queries.

1 endpoint

Cryptocurrency

Crypto balance queries, transaction tracking, withdrawal operations.

3 endpoints

EC2 Management

Instance status monitoring.

1 endpoint

System

Health checks and system status.

2 endpoints

Try It -- Interactive Testing

Each endpoint in the Shooter and Jeeves API tabs features an interactive "Try It" panel powered by Stoplight Elements. To use it:

  1. Set your test server URL in the top bar (click Apply).
  2. Switch to the Shooter API, Jeeves API, or Portal API tab.
  3. Select any endpoint from the sidebar.
  4. Fill in the request body with your test data.
  5. Click Send to execute the request and see the live response.

Note: Ensure your test server has CORS enabled or use a browser extension to bypass CORS restrictions during development.