Royal Slot Gaming API Integration Transfer Wallet

1. Brief Introduction

1-1 Site Restrictions

This system allows creation of multiple sites by merchant.

1-2 Player Restrictions

This system allows creation of multiple member accounts under each site built respectively by merchant.

1-3 Login Restrictions

This system does not allow simultaneous login by members. Where the login reaches limit, the first login will be logged out and the second login will be allowed.

1-4 Currency Restrictions

This system allows a member to own accounts in different currencies. Accounts for different currencies shall be created respectively.

1-5 Explanations on Names

System Code: Code filled in by merchant upon application for using this system.

Web ID: The merchant may set respective codes for multiple sites.

1-6 The Game System provides the following APIs

2. Flow Chart

2-1 Create Member Account (Accounts by Currencies)

2-2 Game Entering Process

3. API Use Descriptions

3-1 Interfacing Information

Interfacing Information ：

The system provides a merchant the information as follows:

3-2 Send Request

1. Request Body is required to be“Msg=Sent Parameter (JSON format) for performing DES-CBC results after encryption”

2. Header is required to be the following three items

3. Make POST Request on URL to be operated

4. FAQ

1. The request Body does not include Msg=

   ❌ The request body only contains the encrypted result but does not include Msg=.

   xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

   ✅ The request body must include Msg=.

   Msg=xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

2. The request body uses double quotes.

   ❌ The request body uses double quotes.

   Msg="xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE="

   ✅ The request body DOES NOT use double quotes.

   Msg=xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

3. The response body includes Msg=

   ❌ The response body includes Msg=

   Msg=xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

   ✅ The response body DOES NOT include Msg=

   xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

4. The numeric type of the request parameters (e.g., int, decimal) was mistakenly enclosed in double quotes.

   Take the API parameter Balance in 5-2 as an example.

   ❌ The numeric type of the request parameter (e.g., int, decimal) was mistakenly enclosed in double quotes.

   { "Balance":"100000.05" }

   ✅ The numeric types (e.g., int, decimal) of the request parameters DO NOT use double quotes for the parameter value

   { "Balance":100000.05 }

3-3 Encryption Example

Original Data

DES-CBC

{"SystemCode":"TestSystem"} => xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

md5 Encryption

3df82c9b0af3p@ssw0rd1494946640xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=

MD5 => 9b58bd658add3e92ed214b6c3c0cbc87

Request POST / request_url

3-4 Code DES Example

shown on the right (click on the php or csharp menu)

/// <summary>Encrypt</summary>
$encrypt_data = openssl_encrypt($data,'DES-CBC',$DesKey,OPENSSL_RAW_DATA ,$DesIV);
$req_base64 = base64_encode($encrypt_data);
var_dump($req_base64);

/// <summary>Decrypt</summary>
$data = openssl_decrypt(base64_decode($req_base64),'DES-CBC',$DesKey,OPENSSL_RAW_DATA ,$DesIV);
var_dump($data);

/// <summary>Encrypt</summary>
public static string DESEncryption(string plainText, string key, string iv)
{
  using(var des = DES.Create())
  {
    des.Mode = CipherMode.CBC;
    des.Padding = PaddingMode.PKCS7;
    des.Key = Encoding.UTF8.GetBytes(key);
    des.IV = Encoding.UTF8.GetBytes(iv);

    byte[] plainByteArray = Encoding.UTF8.GetBytes(plainText);
    byte[] cipherByteArray = des.CreateEncryptor().TransformFinalBlock(plainByteArray, 0, 
    plainByteArray.Length);

    string cipherText = Convert.ToBase64String(cipherByteArray);
    return cipherText;
  }
}

/// <summary>Decrypt</summary>
public static string DESDecrypt(string text, string key, string iv)
{
  using (var des = DES.Create())
  {
    des.Mode = CipherMode.CBC;
    des.Padding = PaddingMode.PKCS7;
    des.Key = Encoding.UTF8.GetBytes(key);
    des.IV = Encoding.UTF8.GetBytes(iv);

    byte[] plainByteArray = Convert.FromBase64String(text);
    byte[] cipherByteArray = des.CreateDecryptor().TransformFinalBlock(plainByteArray, 0, 
    plainByteArray.Length);

    string cipherText = Encoding.UTF8.GetString(cipherByteArray);
    return cipherText;
  }
}

3-5 Code MD5 Example

shown on the right (click on the php or csharp menu)

/// <summary>Encrypt</summary>
$encrypt_data = openssl_encrypt($data,'DES-CBC',$key,OPENSSL_RAW_DATA ,$iv); 
$req_base64 = base64_encode($encrypt_data); 

$timestamp=time(); 

/// <summary>Generate Signature</summary> 
$signature_data=$clientid.$clientsecret.$timestamp.$req_base64; 
$signature=md5($signature_data); 

/// <summary>Generate Signature</summary>
public static string CreateSignature(string clientID, string clientSecret, string timestamp, string 
encryptData)
{
  using(var md5 = MD5.Create())
  {
    var inputText = clientID + clientSecret + timestamp + encryptData;
    var inputByteArray = Encoding.UTF8.GetBytes(inputText);
    var outputByteArray = md5.ComputeHash(inputByteArray);
    var outputText = ByteToHexBitFiddle(outputByteArray);
    return outputText;
  }
}
public static string ByteToHexBitFiddle(byte[] bytes)
{
  char[] c = new char[bytes.Length * 2];
  int b;
  for (int i = 0; i < bytes.Length; i++)
  {
    b = bytes[i] >> 4;
    c[i * 2] = (char)(55 + b + (((b - 10) >> 31) & -7));
    b = bytes[i] & 0xF;
    c[i * 2 + 1] = (char)(55 + b + (((b - 10) >> 31) & -7));
  }
  return new string(c);
}

3-6 Call API Example

Send

Send

{
    "SystemCode":"TestSystem",
    "WebId":"Uy2m48TRCUo",
    "UserId":"497OHx21A0gInxza7zJj",
    "UserType":1,
    "Currency":"KRW"
}

Response

{
    "ErrorCode":0,
    "ErrorMessage":"OK",
    "Timestamp":1584512886,
    "Data":
    {
        "SystemCode":" TestSystem",
        "WebId":"Uy2m48TRCUo",
        "UserId":"497OHx21A0gInxza7zJj"
    }
}

POST /WithBalance/Player/CreatePlayer HTTP/1.1
Host: 192.168.1.102:8866
Content-Type: application/x-www-form-urlencoded
X-API-ClientID: 3df82c9b0af3
X-API-Signature: 45d828b54aa091a5b137351e64673258
X-API-Timestamp: 1494946640

shown on the right (click on the json menu)

4. API Request, Header and Return Information Descriptions

4-1 Request URL

4-2 Header

Each API request is required to contain the following Header, or otherwise the error code will be returned. For error codes, please refer to 8-1

The incoming Timestamp with calls more than 30 seconds from current time will be listed as illegal call. The Invalid decrypt error message will be returned.

4-3 Incoming Parameter Descriptions

In each API request, the incoming Key is request. The Value will be in JSON format encoded using UTF-8 (For related information, please refer to 5. Game System API Descriptions), which are data encrypted via DES; therefore, the values need to be decrypted as well as certified via MD5 before use, or otherwise the error message Invalid decrypt will be returned.

4-4 Return Information Descriptions

When successful 

{
    "ErrorCode":0,
    "ErrorMessage":"OK",
    "Timestamp":1584512886,
    "Data":
    {
    "SystemCode":" TestSystem",
    "WebId":"Uy2m48TRCUo",
    "UserId":"497OHx21A0gInxza7zJj"
    }
}

When failed 
{
    "ErrorCode":2001,
    "ErrorMessage":"Illegal arguments.",
    "Timestamp":1584512886,
    "Data":null
}

Each API, no matter with successful or failed execution, will be in JSON format encoded via UTF-8 and encrypted via DES before return. In addition, the contents shall contain the following information (For information of JSON format in data, please refer to 5. Game System API Descriptions).

Example (This example is in plaintext)

/WithBalance/Player/CreatePlayer returns information as shown in the following table

The JSON format of success and failure is as shown on the right (click on the json menu)

5. Game System API Descriptions 🚀

The following three major types of error codes may be received by all APIs

5-1 Create Member Account(Accounts by Currencies)

API Name：WithBalance/Player/CreatePlayer

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note : For WebId, please set custom Web ID following rules in description (backend addition in advance not required)

5-2 Deposit Points

API Name：WithBalance/Player/Deposit

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note : For TransactionID, please set custom ID following rules in description

5-3 Withdraw Points

API Name：WithBalance/Player/Withdraw

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note : For TransactionID, please set custom ID following rules in description

5-4 Query Points

API Name：WithBalance/Player/GetBalance

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-5 Query PointsTransaction Results

API Name：WithBalance/Player/GetTransactionResult

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-6 Query PointsTransaction History

API Name：WithBalance/Player/GetTransactionHistory

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. Where the query date is 2020-04-24, the results will fall between 2020-04-24 12:00:00 and 2020-04-25 11:59:59

2. The range available for inquiry is within 180 days.

5-7 Get Game URL(Enter Game)

API Name：WithBalance/Player/GetURLToken

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note: When ExitAction contains empty string ( ExitAction=”” ) , the window will be shut down after leaving the game

5-8 Get List of Members in the Game

API Name：WithBalance/Player/PlayerOnlineList

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-9 Kick Out Members in the Game

API Name：WithBalance/Player/Kickout

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

When KickType=1, all members in the system will be kicked out

,KickType=2, all members on the site will be kicked out

,KickType=3, all members in the specific game will be kicked out

,KickType=4, specific member(s) will be kicked out

When KickType=1, enter empty string for WebId and UserId, and enter 0 for GameId

,KickType=2, enter empty string for UserId, and enter 0 for GameId

,KickType=3, enter empty string for WebId and UserId

,KickType=4,enter 0 as GameId

This API will return number of members meeting the kick out conditions. Members matching the conditions will be kicked out of the system in second

5-10 Get Account Information of Members with Point Balance more than 0 (has left the game)

API Name：WithBalance/Player/GetUnwithdrawn

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-11 Get List of Games

API Name：WithBalance/Game/GameList

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-12 Get Game Details

API Name：WithBalance/History/GetGameDetail

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. The range available for query is three minutes prior to the current time, and the max. range is 72 hours prior to the current time.
   E.g. It’s 2020-04-24 16:30 now, and the range of query will fall between 2020-04-24 16:26 ～ 2020-04-21 16:31

2. For WebId with a value, only data under such WebId will be returned.

3. When WebId is with empty string, all data of such system will be returned.

4. The max. period for each query will be five minutes. e.g. TimeStart = 2020-04-24 16:22, and TimeEnd = 2020-04-24 16:26, the data within the 5-minute period between 2020-04-24 16:22:00 ~ 2020-04-24 16:26:59 will be acquired.

5-13 Get Game Minute Report

API Name：WithBalance/Report/GetGameMinReport

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. The range available for query will be three minutes prior to the current time, and the max. range will be 72 hours prior to the current time.
   e.g. It’s 2020-04-24 16:30 now, and the range of query will fall between 2020-04-24 16:26 ～ 2020-04-21 16:31

2. For WebId with a value, only data under such WebId will be returned.

3. When WebId is with empty string, all data of such system will be returned.

4. The max. period for each query will be fifteen minutes. e.g. TimeStart = 2020-04-24 16:12, and TimeEnd = 2020-04-24 16:26, the stats for each minute within the 15-minute period between 2020-04-24 16:12 ~ 2020-04-24 16:26:59 will be acquired.

5-14 Get Game Daily Report

API Name：WithBalance/Report/GetGameDailyReport

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. Where the query date is 2020-04-24, the range for the data acquired is 2020-04-24 12:00:00 to 2020-04-25 11:59:59

2. The start date available for query is one day prior to the current date, and the max. period of query is within 60 days prior to the query date.
   e.g. It’s now 2020-04-24 10:30, and the start date available for query is
   2020-04-22

3. For WebId with a value, only data under such WebId will be returned.

4. When WebId is with empty string, all data of such system will be returned.

5-15 Get Game History URL for Certain Account at Certain Minute(s)

API Name：WithBalance/Player/GetGameMinDetailURLToken

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-16 Get Game History URL for Certain Account at Certain Minute(s) ( By SequenNumber )

API Name：WithBalance/Player/GetGameMinDetailURLTokenBySeq

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

The source of SequenNumber is 5-13, which is returned by the API to obtain
statistics information per minute of the game. Data/GameReport/SequenNumber The game record number starting from the minute

5-17 Get Game Record in Slot History of a Certain Account

API Name：WithBalance/Player/GetSlotGameRecordURLToken

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-18 Get Game Lobby URL(Enter Game Lobby)

API Name：WithBalance/Player/GetLobbyURLToken

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-19 Query Online Status of Member

API Name：WithBalance/Player/GetPlayerOnlineStatus

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-20 Get Game Daily Report(All Game Types)

API Name：WithBalance/Report/GetGameDailyReportAllGameType

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

5-21 Get Game Hour Report

API Name：WithBalance/Report/GetGameHourReport

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. When Query Hour is 2021-11-23 12, the data range acquired will be 2021-11-23 12:00:00 to 2021-11-23 12:59:59.

2. The range available for query is two hours prior to current time, and the max. range will be 1440 hours (within 60 days) prior to current time. e.g. It’s now 2021-11-23 14:02, and the range available for query will be 2021-09-24 14～ 2021-11-23 12

3. For WebId with a value, only data under such WebId will be returned.

4. When WebId is with empty string, all data of such system will be returned.

5-22 Get Game Hour Report(All Game Types)

API Name：WithBalance/Report/GetGameHourReportAllGameType

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. When Query Hour is 2021-11-23 12, the acquired data range will be 2021-11-23 12:00:00 to 2021-11-23 12:59:59.

2. The range available for query is two hours prior to current time，and the max. range available for query is 1440 hours (within 60 days). e.g. It’s now 2021-11-23 14:02, and the range available for query is 2021-09-24 14～ 2021-11-23 12

3. For WebId with a value, only data under such WebId will be returned.

4. When WebId is with empty string, all data of such system will be returned.

5-23 Get Jackpot Records

API Name：WithBalance/Jackpot/GetJackpotHitRec

• Incoming Parameter Descriptions

• Return Information Descriptions

• Overview of Specific Return Error Codes

Note:

1. When Query Date is 2021-11-22 ~ 2021-11-24, the acquired data range is 2021-11-22 12:00:00 to 2021-11-25 11:59:59.

2. The max. query range is within 60 days prior to current date. e.g. It’s now 2021-11-24 19:12:28, and the range available for query is 2021-09-25 ～ 2021-11-24

3. For WebId with a value, only data under such WebId will be returned.

4. When WebId is with empty string, all data of such system will be returned.

5. Forms of JackpotType

6. FTP Function

6-1 About Functions

FTP Method shall provide the three types of data as follows

1. Detailed Game Transaction Information

2. Game Stats by Minutes

3. Game Stats by Day

6-2 About Directory

The directory in FTP will be sorted by Data Category and Game Category at first level, followed by sorting by date at second level, e.g. 20200325, 20200326, Game Stats by Day does not contain a sub level of directory.

Directory Example:

1. Detailed Game Transaction Information：history_fish / 20200325

2. Game Stats by Minutes：report_min_slot / 20200326

3. Game Stats by Day：report_daily

6-3 About Name of Compressed Folder

1. The name to compressed folders of Detailed Game Transaction Information and Game Stats by Minutes is composed of Data Category, Game Category, System Code, Start Time and End Time
   Folder Name Example:
   report_min_slot_TestSystem_202003251710_202003251719.zip

2. The data time range contained in this compressed folder：2020-03-25 17:10:00 ~ 17:19:59 in which contains files from within a max. range of 10 minutes The name to compressed folders of Daily Stats Information is composed of Data Category, System Code and Date
   Folder Name Example:
   report_daily_TestSystem_20200325.zip

6-4 About File Name

The name to Detailed Game Transaction Information and Game Stats by Minutes files in .csv format will be in order of Data Category, Game Category, System Code, Web ID、Per Minute

File Name Example:

report_min_slot_TestSystem_web4_20200325_1712.csv

Such csv file contains data within time range of：2020-03-25 17:12:00 ~ 17:12:59

File name of Daily Stats Information:

The file will be named with components in order of Data Category, Game Category, System Code, Web ID, Date

Folder Name Example:

report_min_slot_TestSystem_web4_20200325.csv

6-5 About Fields

1. Detailed Game Transaction Information: Refer to 5-12 Get Game Details

2. Game Stats by Minutes: Refer to 5-13 Get Game Minute Report

3. Game Daily Stats Information: Refer to 5-14 Get Game Daily Report

7. API Get Details And Record URL

7-1 Slot Game

1. 5-12 Get Game Details ( WithBalance/History/GetGameDetail )

2. 5-17 Get Game Record in Slot History of a Certain Account ( WithBalance/Player/GetSlotGameRecordURLToken )

7-2 Fishing Game

Due to greater volume of data from fishing game, following with the contents below is suggested

1. 5-13 Get Game Minute Report ( WithBalance/Report/GetGameMinReport )

2. Get Game History URL for Certain Account at Certain Minute(s)

   a. Parameter being "Minute" 5-15 (WithBalance/Player/GetGameMinDetailURLToken)

   b. Parameter being "Seq" 5-16 (WithBalance/Player/GetGameMinDetailURLTokenBySeq)

The above (1) is the compilation of fishing game by minutes, and (2) is the link to Per Minute list of details (apply either a or b) Seq refers to the first SequenNumber of such minute

8. Error Code

8-1 Table of Error Codes

8-2 3 Circumstances Resulting in Error Code 2002 :

1. Encrypt Error

2. Failure to send body by Msg=xxxxx method upon data POST

3. Time error in X-API-Timestamp, which the incoming Timestamp exceeds the current calls with more than 30 seconds

8-3 Frequently Seen Circumstances Resulting in Error Code 2001 :

1. Quotation marks for Value Type ( Int, Long, Decimal ) Parameters shall be removed upon sending

   Incorrect => {"GameId": "36"}，Correct => {"GameId": 36}

2. Time parameter. Take extra care to Length and description of API parameter. There are a total of three types of parameters as follows

   yyyy-MM-dd HH:mm

   yyyy-MM-dd HH

   yyyy-MM-dd

Appendix A - Game Codes

Version: v1.16.0

1. Game Codes

1-1 Descriptions

These game codes are for game interfacing, and for identification use after obtaining historical records.

Currently, 85 slot games , 2 fishing games and 1 Arcade game are available. In the game screen, "Happy Farm" and "Power of Thor" supports vertical and horizontal styles,

"Rich Mahjong", "Rich Mahjong 2", "Caishen Fortunes", "Dragon Legend", "Luchadors" , "Caishen Coming" , "Fortune Gems 4" , "Super Ace 2" , "Fortune of Aztecs" , "Lucky Dog" , "Night Market 3" and "Chinese New Year 3" only supports vertical styles,

and the others only support horizontal styles.

1-2 Slot Game Codes( only in horizontal)

1-3 Slot Game Codes(only in vertical)

1-4 Slot Game Codes(Both vertical and horizontal)

1-5 Fishing Game Codes( game screen horizontal only)

1-6 Arcade Game Codes( game screen horizontal only)

2. Subgame Codes

2-1 Descriptions

Codes are for identification use after obtaining historical records

2-2 Slot Subgame Codes

2-3 Fishing Subgame Codes

Appendix B - Currency Codes

Version: v1.4.0

Appendix C - Language Codes

Version: v1.1.0

Appendix D - Release Notes

1.13.0

1. Adding 4 currencies
   • Japanese Yen 130
   • Vietnamese Dong (Original)
   • Thai Baht 5000
   • Lao Kip (Original)

1.12.0

1. Power of Thor supports both vertical and horizontal.

1.11.0

1. Adding 2 games
   • Slot game
     • Night Market 3
     • Chinese New Year 3

1.10.0

1. Adding 5 games
   • Slot game
     • Jurassic Treasure
     • Fortune of Aztecs
     • Rich Mahjong 2
     • Lucky Dog
   • Arcade game
     • Crown 5PK

1.9.1

1. Fix the api name of 5-20

1.9.0

1. Adding 2 games
   • Fortune Gems 4
   • Super Ace 2

1.8.0

1. Adding FAQ in section 3-2 Send Request
2. Adding back to index url.

1.7.0

1. Convert the API documentation from the PDF file to a web site. This version serves as the initial web-based release.

1.6.0

1. Fixing the 3-5 PHP code MD5 example.

2. Add parameter to API:

   • 5-18 Retrieve Game Lobby URL (enter game lobby) - WithBalance/Player/GetLobbyURLToken Add a new URL parameter when exiting: ExitAction. This parameter is optional and does not need to be required passed.

3. Add ErrorCode = 3018, indicating that the currency is not allowed. The APIs that will return this error are as follows:

   • 5-1 Create Player (currency account) - WithBalance/Player/CreatePlayer
   • 5-2 Deposit Points - WithBalance/Player/Deposit
   • 5-3 Withdraw Points - WithBalance/Player/Withdraw
   • 5-7 Retrieve Game URL (enter game) - WithBalance/Player/GetURLToken
   • 5-18 Retrieve Game Lobby URL (enter game lobby) - WithBalance/Player/GetLobbyURLToken