皇家電子遊戲 整合轉帳錢包 API
1. 簡介
1-1 站台限制
本系統允許介接廠商(平台)自行建立多個站台。
1-2 玩家限制
本系統允許介接廠商(平台)自建的每個站台可建立多個會員。
1-3 登入限制
本系統同一會員同時只允許一個登入,達允許上限時,將會後踢前。
1-4 幣別限制
本系統允許同一會員擁有不同幣別的帳戶,各帳戶需個別建立。
1-5 名稱解釋
系統代碼:介接廠商(平台)申請使用本系統時所填寫之代號
站台代碼:介接廠商(平台)可為多個站台,自定各自的代碼
1-6 遊戲系統提供下列 API 程序
API 名稱 | 描述 |
---|---|
WithBalance/Player/CreatePlayer | 建立會員(幣別帳戶) |
WithBalance/Player/Deposit | 存入點數 |
WithBalance/Player/Withdraw | 取出點數 |
WithBalance/Player/GetBalance | 查詢點數 |
WithBalance/Player/GetTransactionResult | 查詢點數交易結果 |
WithBalance/Player/GetTransactionHistory | 查詢點數交易歷程 |
WithBalance/Player/GetURLToken | 取得遊戲網址(進入遊戲) |
WithBalance/Player/PlayerOnlineList | 取得遊戲中的會員 |
WithBalance/Player/Kickout | 剔除遊戲中的會員 |
WithBalance/Player/GetUnwithdrawn | 取得點數不為0的會員帳戶資訊 (已離開遊戲) |
WithBalance/Game/GameList | 取得遊戲列表 |
WithBalance/History/GetGameDetail | 取得遊戲詳細資訊 |
WithBalance/Report/GetGameMinReport | 取得遊戲每分鐘統計資訊 |
WithBalance/Report/GetGameDailyReport | 取得遊戲每日統計資訊 |
WithBalance/Player/GetGameMinDetailURLToken | 取得某帳戶某分鐘內的遊戲歷程網址 |
WithBalance/Player/GetGameMinDetailURLTokenBySeq | 取得某帳戶某分鐘內的遊戲歷程網址(By Seq) |
WithBalance/Player/GetSlotGameRecordURLToken | 取得某帳戶slot遊戲歷程的遊戲盤面 |
WithBalance/Player/GetLobbyURLToken | 取得遊戲大廳網址(進入遊戲大廳) |
WithBalance/Player/GetPlayerOnlineStatus | 查詢會員線上狀態 |
WithBalance/Report/GetGameDailyReportAllGameType | 取得遊戲每日統計資訊(全部遊戲類型) |
WithBalance/Report/GetGameHourReport | 取得遊戲每小時統計資訊 |
WithBalance/Report/GetGameHourReportAllGameType | 取得遊戲每小時統計資訊(全部遊戲類型) |
WithBalance/Jackpot/GetJackpotHitRec | 取得Jackpot 中獎紀錄 |
2. 流程圖
2-1 建立會員(幣別帳戶)
2-2 進遊戲流程
3. API 使用說明
3-1 介接資訊
系統會提供給介接廠商(平台) 以下資訊:
欄位名稱 | 說明 |
---|---|
Client ID | 包含數字與英文字母大小寫的字串值 |
Client Secret | 包含特殊符號的字串值,用於 md5 加密演算 |
Deskey | 用於 DES-CBC 加解密的 Key |
DesIV | 用於 DES-CBC 加解密的偏移量 |
3-2 發送請求
1. 請求內文 需為“Msg=傳送的參數(JSON 格式)進行 DES-CBC 加密後的結果”
2. 標頭 需有以下 3 項
標頭 | 內容 |
---|---|
X-API-ClientID | 系統提供的 Client ID |
X-API-Signature | MD5(Client ID+Client Secret+Timestamp+參數加密後的結果) |
X-API-Timestamp | 當下的 unix timesamp |
3. 對欲進行操作的 URL 做 POST 請求
4. 常見問題
請求內文 (Request Body) 未加上Msg=
❌ 請求內文 (Request Body) 只有加密後的結果,但未加上Msg=
xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
✅ 請求內文 (Request Body) 一定要加上Msg=
Msg=xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
請求內文 (Request Body) 使用雙引號
❌ 請求內文 (Request Body) 使用了雙引號
Msg="xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE="
✅ 請求內文 (Request Body) 不需要加上雙引號
Msg=xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
回覆內文 (Response Body) 加上Msg=
❌ 回覆內文 (Response Body) 加上Msg=
Msg=xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
✅ 回覆內文 (Response Body) 不需要加上Msg=
xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
請求參數的數字型別 (ex. int, decimal) 參數內容誤用雙引號
以 5-2 的 API 參數 Balance 為例
❌ 請求參數的數字型別 (ex. int, decimal) 參數內容誤用雙引號
{ "Balance":"100000.05" }
✅ 請求參數的數字型別 (ex. int, decimal) 參數內容不使用雙引號
{ "Balance":100000.05 }
3-3 加密範例
原始資料
欄位 | 加密內容 |
---|---|
Client ID | 3df82c9b0af3 |
Client Secret | p@ssw0rd |
當下的 unix timestamp | 1494946640 |
DesKey | N5MF76P7 |
DesIV | 4ANG4ACY |
參數 | {"SystemCode":"TestSystem"} |
DES-CBC
{"SystemCode":"TestSystem"} => xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
md5 加密
3df82c9b0af3p@ssw0rd1494946640xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE=
MD5 => 9b58bd658add3e92ed214b6c3c0cbc87
請求資料 POST / request_url
Content-Type | application/x-www-form-urlencoded |
X-API-ClientID | 3df82c9b0af3 |
X-API-Signature | 9b58bd658add3e92ed214b6c3c0cbc87 |
X-API-Timestamp | 1494946640 |
Msg= | xkf7wEkQvp+LJTravXHY9RDEX24YMjQxnV/5DPCoIKE= |
3-4 程式碼 DES 範例
php 與 csharp 範例如右(點選php或csharp選單)
/// <summary>加密</summary>
$encrypt_data = openssl_encrypt($data,'DES-CBC',$DesKey,OPENSSL_RAW_DATA ,$DesIV);
$req_base64 = base64_encode($encrypt_data);
var_dump($req_base64);
/// <summary>解密</summary>
$data = openssl_decrypt(base64_decode($req_base64),'DES-CBC',$DesKey,OPENSSL_RAW_DATA ,$DesIV);
var_dump($data);
/// <summary>加密</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>解密</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 程式碼 MD5 範例
php 與 csharp 範例如右(點選php或csharp選單)
$encrypt_data = openssl_encrypt($data,'DES-CBC',$key,OPENSSL_RAW_DATA ,$iv);
$req_base64 = base64_encode($encrypt_data);
$timestamp=time();
/// <summary>產生簽章</summary>
$signature_data=$clientid.$clientsecret.$timestamp.$req_base64;
$signature=md5($signature_data);
/// <summary>產生簽章</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 調用 API 舉例
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
json 範例如右(點選json選單)
4. API 請求、標頭以及回傳資訊說明
4-1 請求 URL
名稱 | 內容 |
---|---|
URL | http://<server>/<API 名稱> |
方法 | POST |
4-2 標頭
各 API 請求時,皆需有如下的標頭,否則回傳錯誤代碼,錯誤代碼請參考 8-1
名稱 | 型別 | 必要 | 描述 |
---|---|---|---|
X-API-ClientID | String | Y | 請求的連線端 ID |
X-API-Signature | String | Y | 請求的簽章 |
X-API-Timestamp | String | Y | 請求的時間戳記,格式為 unix timestamp |
傳入的 Timestamp 超過現在時間 30 秒以上的呼叫,將被列為不合法的呼叫,會回傳 Invalid decrypt 的錯誤訊息。
4-3 傳入參數說明
各 API 請求時,傳入的 Key 為 request,Value 為以 UTF-8 編碼的 JSON 格式(相關資訊請參閱 「5. 遊戲系統 API 說明」),且經 DES 加密後資料,故使用時需經過解密,且要通過 MD5 的 認證才可使用,否則會回傳 Invalid decrypt 的錯誤訊息。
4-4 回傳資訊說明
成功時
{
"ErrorCode":0,
"ErrorMessage":"OK",
"Timestamp":1584512886,
"Data":
{
"SystemCode":" TestSystem",
"WebId":"Uy2m48TRCUo",
"UserId":"497OHx21A0gInxza7zJj"
}
}
失敗時
{
"ErrorCode":2001,
"ErrorMessage":"Illegal arguments.",
"Timestamp":1584512886,
"Data":null
}
各 API 不論執行成功或失敗,皆會以 UTF-8 編碼的 JSON 格式經 DES 加密後回傳,且內容包 含下列資訊(Data 中的 JSON 格式資訊請參閱「5. 遊戲系統 API 說明」)。
名稱 | 型別 | 描述 |
---|---|---|
ErrorCode | Int | 錯誤代碼,詳細請參考 8-1 錯誤代碼表 |
ErrorMessage | String | 錯誤訊息,詳細請參考 8-1 錯誤代碼表 |
Timestamp | Long | 時間戳記 |
Data | Object | API 呼叫回傳的 JSON 格式的 object / object array |
範例(此範例為明碼) /WithBalance/Player/CreatePlayer 回傳資訊如下表
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/SystemCode | String | 系統代碼 |
Data/WebId | String | 站台代碼 |
Data/UserId | String | 會員的唯一識別碼 |
成功與失敗的 json 格式如右(點選json選單)
5. 遊戲系統 API 說明 🚀
以下三大類的錯誤代碼為所有 API 都可能會收到的
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
0 | OK | 正常 |
1xxx | 系統有誤或是維護中 | |
2xxx | 參數輸入驗證有誤 |
5-1 建立會員(幣別帳戶)
API 名稱:WithBalance/Player/CreatePlayer
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/SystemCode | String | 系統代碼 |
Data/WebId | String | 站台代碼 |
Data/UserId | String | 會員的唯一識別碼 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3010 | The player's currency already exists. | 此玩家帳戶已存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3018 | This currency is not allowed. | 此幣別不被允許 |
補充說明:WebId 請依描述的規則自訂站台代碼 (不需在後台先新增)
5-2 存入點數
API 名稱:WithBalance/Player/Deposit
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
TransactionID | String | 8~20 | Y | 交易惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
Balance | Decimal | Y | 存入點數(小數點兩位) (範圍0.01~9999999999.99) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/TransactionID | String | 交易惟一識別碼 |
Data/TransactionTime | String | yyyy-MM-dd HH:mm:ss |
Data/UserId | String | 會員惟一識別碼 |
Data/PointID | String | 點數交易序號 |
Data/Balance | Decimal | 存入點數 |
Data/CurrentPlayerBalance | Decimal | 會員當前點數 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3014 | Duplicate TransactionID. | 重複的TransactionID |
3018 | This currency is not allowed. | 此幣別不被允許 |
補充說明: TransactionID請依描述的規則自訂此識別碼
5-3 取出點數
API 名稱:WithBalance/Player/Withdraw
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
TransactionID | String | 8~20 | Y | 交易惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
Balance | Decimal | Y | 取出點數(小數點兩位) (範圍0.01~9999999999.99) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/TransactionID | String | 交易惟一識別碼 |
Data/TransactionTime | String | yyyy-MM-dd HH:mm:ss |
Data/UserId | String | 會員惟一識別碼 |
Data/PointID | String | 點數交易序號 |
Data/Balance | Decimal | 取出點數 |
Data/CurrentPlayerBalance | Decimal | 會員當前點數 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3005 | Balance is not enough. | 餘額不足 |
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3014 | Duplicate TransactionID. | 重複的TransactionID |
3016 | Deny withdraw, player is in gaming. | 拒絕提點,玩家正在遊戲中 |
3018 | This currency is not allowed. | 此幣別不被允許 |
補充說明: TransactionID請依描述的規則自訂此識別碼
5-4 查詢點數
API 名稱:WithBalance/Player/GetBalance
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/UserId | String | 會員惟一識別碼 |
Data/CurrentPlayerBalance | Decimal | 會員當前點數 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
5-5 查詢點數交易結果
API 名稱:WithBalance/Player/GetTransactionResult
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
TransactionID | String | 8~20 | Y | 交易惟一識別碼(只限英數) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/TransactionID | String | 交易惟一識別碼 |
Data/TransactionTime | String | yyyy-MM-dd HH:mm:ss |
Data/WebId | String | 站台代碼 |
Data/UserId | String | 會員惟一識別碼 |
Data/PointID | String | 點數交易序號 |
Data/Currency | String | 幣別代碼(請參照代碼表) |
Data/Action | Int | 1.存點 2.取點 |
Data/Balance | Decimal | 交易點數 |
Data/AfterBalance | Decimal | 交易後點數 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3006 | Transaction is not found. | 找不到交易結果 |
3011 | Deny permission for system. | 系統商權限不足 |
5-6 查詢點數交易歷程
API 名稱:WithBalance/Player/GetTransactionHistory
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
DateStart | String | 10 | Y | 查詢開始日期(yyyy-MM-dd) |
DateEnd | String | 10 | Y | 查詢結束日期(yyyy-MM-dd) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/TranHistory | Array | |
Data/TranHistory/TransactionID | String | 交易惟一識別碼 |
Data/TranHistory/TransactionTime | String | yyyy-MM-dd HH:mm:ss |
Data/TranHistory/PointID | String | 點數交易序號 |
Data/TranHistory/Action | Int | 1.存點 2.取點 |
Data/TranHistory/Balance | Decimal | 交易點數 |
Data/TranHistory/AfterBalance | Decimal | 交易後點數 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
補充說明 :
查詢日期為 2020-04-24,取得的數據範圍為 2020-04-24 12:00:00 至 2020-04-25 11:59:59
可以查詢的範圍為 180 天內。
5-7 取得遊戲網址(進入遊戲)
API 名稱:WithBalance/Player/GetURLToken
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
UserName | String | 1~20 | Y | 會員暱稱 |
GameId | Int | Y | 遊戲代碼(請參照代碼表) | |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
Language | String | 5 | Y | 語系代碼(請參照代碼表) |
ExitAction | String | 0~255 | Y | 離開遊戲時導向特定網址 |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/URL | String | 進入遊戲的網址 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3012 | Deny permission for game. | 遊戲權限不足 |
3018 | This currency is not allowed. | 此幣別不被允許 |
補充說明 : ExitAction 帶空字串 ( ExitAction=”” ) 時,離開遊戲時將關閉視窗
5-8 取得遊戲中的會員
API 名稱:WithBalance/Player/PlayerOnlineList
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
GameId | Int | Y | 遊戲代碼(請參照代碼表) | |
Page | Int | Y | 指定目前頁數(從1開始) | |
Rows | Int | Y | 每頁筆數(範圍:100~500) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/DataCount | Int | 總筆數 |
Data/PageSize | Int | 每頁筆數 |
Data/PageCount | Int | 總頁數 |
Data/PageNow | Int | 目前頁數 |
Data/UserList | Array | |
Data/UserList/WebId | String | 站台代碼 |
Data/UserList/UserId | String | 會員惟一識別碼 |
Data/UserList/GameId | Int | 遊戲代碼(請參照代碼表) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3012 | Deny permission for game. | 遊戲權限不足 |
5-9 剔除遊戲中的會員
API 名稱:WithBalance/Player/Kickout
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
KickType | Int | Y | 剔除模式,有下列4種 1:System, 2:Web, 3:Game, 4:Player | |
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
UserId | String | 0~20 | Y | 會員惟一識別碼(只限英數) |
GameId | Int | Y | 若KickType 不為3,則填0 |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/UserCount | Int | 被剔除的會員數量 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3012 | Deny permission for game. | 遊戲權限不足 |
補充說明 :
當 KickType=1,會剔除系統下所有人,KickType=2,會剔除站台下所有人
,KickType=3,會剔除正在該遊戲的所有人,KickType=4,會剔除特定會員
當 KickType=1,WebId、UserId 請填空字串,GameId 請填 0
,KickType=2,UserId 請填空字串,GameId請填 0
,KickType=3,WebId、UserId 請填空字串
,KickType=4,GameId 請填 0
此API會回傳符合剔除條件的會員數量,符合條件者將於數秒內被剔除系統
5-10 取得點數不為0的會員帳戶資訊(已離開遊戲)
API 名稱:WithBalance/Player/GetUnwithdrawn
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/UserList | Array | |
Data/UserList/WebId | String | 站台代碼 |
Data/UserList/UserId | String | 會員惟一識別碼 |
Data/UserList/Currency | String | 幣別代碼(請參照代碼表) |
Data/UserList/Balance | Decimal | 會員尚餘點數 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
5-11 取得遊戲列表
API 名稱:WithBalance/Game/GameList
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameList | Array | |
Data/GameList/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameList/GameType | Int | 遊戲類型(1:老虎機 2:捕魚機) |
Data/GameList/GameName | Object | |
Data/GameList/GameName/en_US | String | 遊戲名稱(英文) |
Data/GameList/GameName/zh_TW | String | 遊戲名稱(繁體中文) |
Data/GameList/GameName/zh_CN | String | 遊戲名稱(簡體中文) |
Data/GameList/GameName/th_TH | String | 遊戲名稱(泰文) |
Data/GameList/GameName/ko_KR | String | 遊戲名稱(韓文) |
Data/GameList/GameName/ja_JP | String | 遊戲名稱(日文) |
Data/GameList/GameName/en_MY | String | 遊戲名稱(緬甸文) |
Data/GameList/GameName/id_ID | String | 遊戲名稱(印尼文) |
Data/GameList/RollerSpec | String | 滾輪規格 |
Data/GameList/LineType | String | 連線類型 |
Data/GameList/LineNumber | String | 連線數 |
Data/GameList/GameStatus | Int | 遊戲狀態(1:正常 2:維護) |
Data/GameList/GamePicUrl | String | 遊戲圖片網址(改由其它方式提供) |
Data/GameList/GameResUrl | String | 遊戲資源網址(改由其它方式提供) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
5-12 取得遊戲詳細資訊
API 名稱:WithBalance//History/GetGameDetail
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
GameType | Int | Y | 遊戲類型(1.老虎機 2.捕魚機) | |
TimeStart | String | 16 | Y | 開始時間(yyyy-MM-dd HH:mm) |
TimeEnd | String | 16 | Y | 結束時間(yyyy-MM-dd HH:mm) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameDetail | Array | |
Data/GameDetail/Currency | String | 幣別代碼(請參照代碼表) |
Data/GameDetail/WebId | String | 站台代碼 |
Data/GameDetail/UserId | String | 會員惟一識別碼 |
Data/GameDetail/SequenNumber | Long | 遊戲紀錄惟一編號 |
Data/GameDetail/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameDetail/SubGameType | Int | 子遊戲代碼(請參照代碼表) |
Data/GameDetail/BetAmt | Decimal | 下注(小數點兩位) |
Data/GameDetail/WinAmt | Decimal | 贏分(小數點兩位) |
Data/GameDetail/PlayTime | String | 遊戲時間 |
Data/GameDetail/JackpotContribution | Decimal | Jackpot貢獻值(小數點五位) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
補充說明:
1.可以查詢的範圍為目前時間的3分鐘前,最多可以查詢到目前時間往前 72 小時內。
譬如目前是 2020-04-24 16:30,只能查詢 2020-04-24 16:26 ~ 2020-04-21 16:31
2.WebId 有填值將只回傳該 WebId 底下的資料
3.WebId 為空字串時,將回傳該系統所有資料
4.每次查詢最多 5 分鐘,譬如 TimeStart = 2020-04-24 16:22,TimeEnd = 2020-04-24 16:26,將取得 2020-04-24 16:22:00 ~
2020-04-24 16:26:59 這 5 分鐘內的資料
5-13 取得遊戲每分鐘統計資訊
API 名稱:WithBalance/Report/GetGameMinReport
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
GameType | Int | Y | 遊戲類型(1.老虎機 2.捕魚機) | |
TimeStart | String | 16 | Y | 開始時間(yyyy-MM-dd HH:mm) |
TimeEnd | String | 16 | Y | 結束時間(yyyy-MM-dd HH:mm) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameReport | Array | |
Data/GameReport/Currency | String | 幣別代碼(請參照代碼表) |
Data/GameReport/WebId | String | 站台代碼 |
Data/GameReport/UserId | String | 會員惟一識別碼 |
Data/GameReport/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameReport/TimeMinute | String | 統計時間(分鐘) |
Data/GameReport/BetSum | Decimal | 下注(小數點兩位) |
Data/GameReport/WinSum | Decimal | 贏分(小數點兩位) |
Data/GameReport/JackpotWinSum | Decimal | 彩金(小數點兩位) |
Data/GameReport/NetWinSum | Decimal | 總輸贏(小數點兩位) |
Data/GameReport/SequenNumber | Long | 該分鐘起始的遊戲紀錄編號 |
Data/GameReport/RecordCount | Int | 筆數 |
Data/GameReport/JackpotContributionSum | Decimal | Jackpot貢獻值(小數點五位) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
補充說明:
1.可以查詢的範圍為目前時間的3分鐘前,最多可以查詢到目前時間往前 72 小時內。
譬如目前是 2020-04-24 16:30,只能查詢 2020-04-24 16:26 ~ 2020-04-21 16:31
2.WebId 有填值將只回傳該 WebId 底下的資料
3.WebId 為空字串時,將回傳該系統所有資料
4.每次查詢最多 15 分鐘,譬如 TimeStart = 2020-04-24 16:12,TimeEnd = 2020-04-24 16:26,將取得 2020-04-24 16:12:00 ~
2020-04-24 16:26:59 這 15 分鐘內的資料
5-14 取得遊戲每日統計資訊
API 名稱:WithBalance/Report/GetGameDailyReport
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
GameType | Int | Y | 遊戲類型(1.老虎機 2.捕魚機) | |
Date | String | 10 | Y | 查詢日期(yyyy-MM-dd) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameReport | Array | |
Data/GameReport/Currency | String | 幣別代碼(請參照代碼表) |
Data/GameReport/WebId | String | 站台代碼 |
Data/GameReport/UserId | String | 會員惟一識別碼 |
Data/GameReport/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameReport/BetSum | Decimal | 下注(小數點兩位) |
Data/GameReport/WinSum | Decimal | 贏分(小數點兩位) |
Data/GameReport/JackpotWinSum | Decimal | 彩金(小數點兩位) |
Data/GameReport/NetWinSum | Decimal | 總輸贏(小數點兩位) |
Data/GameReport/RecordCount | Int | 筆數 |
Data/GameReport/JackpotContributionSum | Decimal | Jackpot貢獻值(小數點五位) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
補充說明:
查詢日期為 2020-04-24, 取得的數據範圍為 2020-04-24 12:00:00 至 2020-04-25 11:59:59
可以查詢的開始範圍為一天前,最多可以查詢到60天內, 譬如目前是 2020-04-24 10:30,可查詢的開始範圍為 2020-04-22
WebId 有填值將只回傳該WebId 底下的資料
WebId 為空字串時,將回傳該系統所有資料
5-15 取得某帳戶某分鐘內的遊戲歷程網址
API 名稱:WithBalance/Player/GetGameMinDetailURLToken
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
GameType | Int | Y | 遊戲類型(1:老虎機 2:捕魚機) | |
GameId | Int | Y | 遊戲代碼(請參照代碼表) | |
Time | String | 16 | Y | 查詢時間(yyyy-MM-dd HH:mm) |
Language | String | 5 | Y | 語系代碼(請參照代碼表) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/URL | String | 查看遊戲盤面的網址 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
5-16 取得某帳戶某分鐘內的遊戲歷程網址 ( By SequenNumber )
API 名稱:WithBalance/Player/GetGameMinDetailURLTokenBySeq
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
GameType | Int | Y | 遊戲類型(1:老虎機 2:捕魚機) | |
GameId | Int | Y | 遊戲代碼(請參照代碼表) | |
SequenNumber | Long | Y | 該分鐘起始的遊戲紀錄編號 | |
Language | String | 5 | Y | 語系代碼(請參照代碼表) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/URL | String | 查看遊戲盤面的網址 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
補充說明:
SequenNumber 的來源為 5-13 取得遊戲每分鐘統計資訊 API回傳的
Data/GameReport/SequenNumber 該分鐘起始的遊戲紀錄編號
5-17 取得某帳戶slot遊戲歷程的遊戲盤面
API 名稱:WithBalance/Player/GetSlotGameRecordURLToken
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
GameId | Int | Y | 遊戲代碼(請參照代碼表) | |
SequenNumber | Long | Y | 遊戲紀錄惟一編號 | |
Language | String | 5 | Y | 語系代碼(請參照代碼表) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/URL | String | 查看遊戲盤面的網址 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
5-18 取得遊戲大廳網址(進入遊戲大廳)
API 名稱:WithBalance/Player/GetLobbyURLToken
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
UserName | String | 1~20 | Y | 會員暱稱 |
Currency | String | 2~5 | Y | 幣別代碼(請參照代碼表) |
Language | String | 5 | Y | 語系代碼(請參照代碼表) |
ExitAction | String | 0~255 | N | 離開遊戲時導向特定網址 |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/URL | String | 進入遊戲的網址 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3018 | This currency is not allowed. | 此幣別不被允許 |
5-19 查詢會員線上狀態
API 名稱:WithBalance/Player/GetPlayerOnlineStatus
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 3~20 | Y | 站台代碼(只限英數) |
UserId | String | 3~20 | Y | 會員惟一識別碼(只限英數) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/UserId | String | 會員惟一識別碼 |
Data/OnlineList | Array | |
Data/OnlineList/Currency | String | 幣別代碼(請參照代碼表) |
Data/OnlineList/GameId | Int | 遊戲代碼(請參照代碼表) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3011 | Deny permission for system. | 系統商權限不足 |
5-20 取得遊戲每日統計資訊(全部遊戲類型)
API 名稱:WithBalance/Report/GetGameDailyReportAllGameType
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
Date | String | 10 | Y | 查詢日期(yyyy-MM-dd) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameReport | Array | |
Data/GameReport/GameType | Int | 遊戲類型(1.老虎機 2.捕魚機) |
Data/GameReport/Currency | String | 幣別代碼(請參照代碼表) |
Data/GameReport/WebId | String | 站台代碼 |
Data/GameReport/UserId | String | 會員惟一識別碼 |
Data/GameReport/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameReport/BetSum | Decimal | 下注(小數點兩位) |
Data/GameReport/WinSum | Decimal | 贏分(小數點兩位) |
Data/GameReport/JackpotWinSum | Decimal | 彩金(小數點兩位) |
Data/GameReport/NetWinSum | Decimal | 總輸贏(小數點兩位) |
Data/GameReport/RecordCount | Int | 筆數 |
Data/GameReport/JackpotContributionSum | Decimal | Jackpot貢獻值(小數點五位) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
5-21 取得遊戲每小時統計資訊
API 名稱:WithBalance/Report/GetGameHourReport
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
GameType | Int | Y | 遊戲類型(1.老虎機 2.捕魚機) | |
Hour | String | 13 | Y | 查詢小時(yyyy-MM-dd HH) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameReport | Array | |
Data/GameReport/Currency | String | 幣別代碼(請參照代碼表) |
Data/GameReport/WebId | String | 站台代碼 |
Data/GameReport/UserId | String | 會員惟一識別碼 |
Data/GameReport/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameReport/BetSum | Decimal | 下注(小數點兩位) |
Data/GameReport/WinSum | Decimal | 贏分(小數點兩位) |
Data/GameReport/JackpotWinSum | Decimal | 彩金(小數點兩位) |
Data/GameReport/NetWinSum | Decimal | 總輸贏(小數點兩位) |
Data/GameReport/RecordCount | Int | 筆數 |
Data/GameReport/JackpotContributionSum | Decimal | Jackpot貢獻值(小數點五位) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
補充說明:
1.查詢小時為 2021-11-23 12,取得的數據範圍為 2021-11-23 12:00:00 至 2021-11-23 12:59:59
2.可以查詢的範圍為目前時間的 2 小時前,最多可以查詢到 1440 小時內(60 天內)。 譬如目前是 2021-11-23 14:02,可查詢範圍為 2021-09-24 14~ 2021-11-23 12
3.WebId 有填值將只回傳該 WebId 底下的資料
4.WebId 為空字串時,將回傳該系統所有資料
5-22 取得遊戲每小時統計資訊(全部遊戲類型)
API 名稱:WithBalance/Report/GetGameHourReportAllGameType
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
Hour | String | 13 | Y | 查詢小時(yyyy-MM-dd HH) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/GameReport | Array | |
Data/GameReport/GameType | Int | 遊戲類型(1.老虎機 2.捕魚機) |
Data/GameReport/Currency | String | 幣別代碼(請參照代碼表) |
Data/GameReport/WebId | String | 站台代碼 |
Data/GameReport/UserId | String | 會員惟一識別碼 |
Data/GameReport/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/GameReport/BetSum | Decimal | 下注(小數點兩位) |
Data/GameReport/WinSum | Decimal | 贏分(小數點兩位) |
Data/GameReport/JackpotWinSum | Decimal | 彩金(小數點兩位) |
Data/GameReport/NetWinSum | Decimal | 總輸贏(小數點兩位) |
Data/GameReport/RecordCount | Int | 筆數 |
Data/GameReport/JackpotContributionSum | Decimal | Jackpot貢獻值(小數點五位) |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
補充說明:
1.查詢小時為 2021-11-23 12,取得的數據範圍為 2021-11-23 12:00:00 至 2021-11-23 12:59:59
2.可以查詢的範圍為目前時間的 2 小時前,最多可以查詢到 1440 小時內(60 天內)。 譬如目前是 2021-11-23 14:02,可查詢範圍為 2021-09-24 14~ 2021-11-23 12
3.WebId 有填值將只回傳該 WebId 底下的資料
4.WebId 為空字串時,將回傳該系統所有資料
5-23 取得 Jackpot 中獎紀錄
API 名稱:WithBalance/Jackpot/GetJackpotHitRec
- 傳入參數說明
名稱 | 型別 | 長度 | 必要 | 描述 |
---|---|---|---|---|
SystemCode | String | 2~20 | Y | 系統代碼(只限英數) |
WebId | String | 0~20 | Y | 站台代碼(只限英數) |
DateStart | String | 10 | Y | 開始日期(yyyy-MM-dd) |
DateEnd | String | 10 | Y | 結束日期(yyyy-MM-dd) |
- 回傳資訊說明
名稱 | 型別 | 描述 |
---|---|---|
Data | Object | |
Data/JackpotHitRec | Array | |
Data/JackpotHitRec/JackpotHitID | Long | 中獎唯一識別號 |
Data/JackpotHitRec/SequenNumber | Long | 遊戲紀錄惟一編號 |
Data/JackpotHitRec/Currency | String | 幣別代碼(請參照代碼表) |
Data/JackpotHitRec/WebId | String | 站台代碼 |
Data/JackpotHitRec/UserId | String | 會員惟一識別碼 |
Data/JackpotHitRec/GameId | Int | 遊戲代碼(請參照代碼表) |
Data/JackpotHitRec/JackpotType | Int | 中獎Jackpot類型(請參照補充說明) |
Data/JackpotHitRec/JackpotWin | Decimal | 彩金(小數點兩位) |
Data/JackpotHitRec/HitTime | String | 中獎時間 |
- 特定回傳錯訊代碼一覽
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
3011 | Deny permission for system. | 系統商權限不足 |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
查詢日期為 2021-11-22 ~ 2021-11-24,取得的數據範圍為 2021-11-22 12:00:00 至 2021-11-25 11:59:59
可以查詢最多 60 天內,譬如目前是 2021-11-24 19:12:28,可查詢範圍為 2021-09-25 ~ 2021-11-24
WebId 有填值將只回傳該 WebId 底下的資料
WebId 為空字串時,將回傳該系統所有資料
JackpotType 的類型
Jackpot Type | 0 | 1 | 2 | 3 |
Jackpot Name | GRAND | MAJOR | MINOR | MINI |
6. FTP 功能
6-1 功能說明
FTP 方式依提供以下三種資料
遊戲詳細交易信息
遊戲每分鐘統計資訊
遊戲每日統計資訊
6-2 目錄說明
FTP 內的目錄第一層會先以資料分類與遊戲分類做區分,
第二層會以日期來區分,譬如:20200325,20200326,
每日統計資訊無第二層目錄。
目錄範例:
遊戲詳細交易信息:history_fish / 20200325
遊戲每分鐘統計資訊:report_min_slot / 20200326
遊戲每日統計資訊:report_daily
6-3 壓縮檔名說明
遊戲詳細交易信息 和 遊戲每分鐘統計資訊 的壓縮檔名
由資料分類、遊戲分類、系統代碼、起始時間、結束時間所組成
檔名範例:
report_min_slot_TestSystem_202003251710_202003251719.zip
該壓縮檔內的資料時間範圍:2020-03-25 17:10:00 ~ 17:19:59
裡面會有最多 10 分鐘內的檔案
每日統計資訊 的壓縮檔名
由資料分類、系統代碼、日期所組成
檔名範例:
report_daily_TestSystem_20200325.zip
6-4 檔名說明
遊戲詳細交易信息 和 遊戲每分鐘統計資訊 的檔名
檔案會依照資料分類、遊戲分類、系統代碼、站台代碼、每分鐘
組成一個 CSV 檔
檔名範例:
report_min_slot_TestSystem_web4_20200325_1712.csv
該 CSV 檔內的資料時間範圍:2020-03-25 17:12:00 ~ 17:12:59
每日統計資訊的檔名
檔案會依照資料分類、遊戲分類、系統代碼、站台代碼、日期
檔名範例:
report_min_slot_TestSystem_web4_20200325.csv
6-5 欄位說明
7. API 取明細與取盤面網址
7-1 老虎機
5-12 取得遊戲詳細資訊 ( WithBalance/History/GetGameDetail )
5-17 取得某帳戶 slot 遊戲歷程的遊戲盤面 ( WithBalance/Player/GetSlotGameRecordURLToken )
7-2 捕魚機
捕魚機由於數據量較多,建議用以下來搭配使用
5-13 取得遊戲每分鐘統計資訊 ( WithBalance/Report/GetGameMinReport )
取得某帳戶某分鐘內的遊戲歷程網址
a. 參數為"分鐘" 5-15 (WithBalance/Player/GetGameMinDetailURLToken)
b. 參數為"Seq" 5-16 (WithBalance/Player/GetGameMinDetailURLTokenBySeq)
以上(1)為捕魚遊戲每分鐘匯總,(2)則為每分鐘細單連結(a 或 b 擇一來使用) Seq 為該分鐘第一個 SequenNumber
8. 錯誤代碼
8-1 錯誤代碼表
代碼類別 | 描述 |
---|---|
0 | 正常 |
1xxx | 系統有誤或是維護中 |
2xxx | 參數輸入驗證有誤 |
3xxx | 邏輯判斷後有誤 |
錯誤代碼 | 錯誤訊息 | 描述 |
---|---|---|
0 | OK | 正常 |
1001 | Execute failed. | 執行失敗 |
1002 | System is in maintenance. | 系統維護中 |
2001 | Illegal arguments. | 無效的參數 |
2002 | Invalid decrypt. | 解密失敗 |
3005 | Balance is not enough. | 餘額不足 |
3006 | Transaction is not found. | 找不到交易結果 |
3008 | The player's currency doesn't exist. | 此玩家帳戶不存在 |
3010 | The player's currency already exists | 此玩家帳戶已存在 |
3011 | Deny permission for system. | 系統商權限不足 |
3012 | Deny permission for game. | 遊戲權限不足 |
3014 | Duplicate TransactionID. | 重複的 TransactionID |
3015 | Time is not in the allowed range. | 時間不在允許的範圍內 |
3016 | Deny withdraw, player is in gaming. | 拒絕提點,玩家正在遊戲中 |
3018 | This currency is not allowed. | 此幣別不被允許 |
8-2 會得到錯誤代碼 2002 的 3 種情況:
加密錯誤
POST 資料時,未在 body 以 Msg=xxxxx 的方式傳送
X-API-Timestamp 時間有誤,傳入的 Timestamp 超過現在時間 30 秒以上的呼叫
8-3 會得到錯誤代碼 2001 的常見情況:
數值型態 ( Int,Long,Decimal ) 的參數,在傳送時請移除雙引號
錯誤 => {"GameId": "36"},正確 => {"GameId": 36}
時間參數,請注意 API 參數的 長度 以及 描述,總計有以下 3 種
yyyy-MM-dd HH:mm
yyyy-MM-dd HH
yyyy-MM-dd
附錄 A - 遊戲代碼表
版本: v1.16.0
1. 遊戲代碼
1-1 說明
本遊戲代碼供遊戲介接以及歷史紀錄獲取後的識別用
目前提供 85 款老虎機、 2 款捕魚機、 1款街機,遊戲畫面「開心農場」和「雷神之錘」
有支援直式與橫式,「麻將發了」和 「麻將發了2」「聚寶財神」、「魔龍傳奇」、「黃金摔角
手」、「有請財神」、「迦羅寶石4」、「超級王牌2」、「勇闖黃金城」、「狗來富」、「逛夜市3」以及「大過年3」只支援直式,其它都只支援橫式
1-2 老虎機遊戲代碼(遊戲畫面只限橫式)
代碼 | en-US | zh-TW | zh-CN | 最後新增 |
---|---|---|---|---|
1 | Fortune Thai | 泰有錢 | 泰有钱 | |
2 | Magic Gem | 魔法石 | 魔法石 | |
3 | Royal 777 | 皇家 777 | 皇家 777 | |
4 | Love City | 慾望城市 | 欲望城市 | |
5 | Gold Chicken | 金鷄報喜 | 金鸡报喜 | |
6 | Pharaoh | 法老王 | 法老王 | |
7 | Alibaba | 阿里巴巴 | 阿里巴巴 | |
8 | Lucky Fruits | 幸運水果 | 幸運水果 | |
10 | Jungle | 動物叢林 | 动物丛林 | |
11 | Captain Hook | 虎克船長 | 虎克船长 | |
12 | HUCA | 野蠻遊戲 | 野蛮游戏 | |
14 | Sweet Candy | 甜蜜糖果 | 甜蜜糖果 | |
15 | Fire Spin | 烈焰轉輪 | 烈焰转轮 | |
16 | Popeye | 大力水手 | 大力水手 | |
17 | Crazy Doctor | 瘋狂博士 | 疯狂博士 | |
18 | Nonstop | 永不停止 | 永不停止 | |
19 | 5 Dragons | 五龍爭霸 | 五龙争霸 | |
21 | 72 Changes | 七十二變 | 七十二变 | |
23 | Mermaid | 人魚傳說 | 人鱼传说 | |
24 | Buffalo | 荒野水牛 | 荒野水牛 | |
25 | Wild Panda | 竹林熊貓 | 竹林熊猫 | |
26 | Lucky Thailand | 泰好運 | 泰好运 | |
27 | God of Wealth | 財神到 | 财神到 | |
28 | Lucky Dragon | 行運一條龍 | 行运一条龙 | |
29 | HUSA | HUSA | HUSA | |
30 | Dragon King | 龍王 | 龙王 | |
31 | TiKi Party | 提金派對 | 提金派对 | |
32 | Goblin Miner | 礦工哥布林 | 矿工哥布林 | |
33 | Lucky Bar | 幸運拉霸 | 幸运拉霸 | |
34 | Africa | 非洲 | 非洲 | |
35 | Wizard Store | 巫師商店 | 巫师商店 | |
36 | Mr.Doggy | 家犬先生 | 家犬先生 | |
37 | Disco Night | 迪斯可之夜 | 迪斯可之夜 | |
38 | Horror Nights | 農場夜驚魂 | 农场夜惊魂 | |
39 | China Empress | 武媚娘 | 武媚娘 | |
40 | FuWaFaFa | 福娃發發 | 福娃发发 | |
41 | Tarzan | 泰山 | 泰山 | |
42 | Jalapeno | 墨西哥辣椒 | 墨西哥辣椒 | |
43 | Piggy Punch | 金豬爆吉 | 金猪爆吉 | |
44 | Sevens High | 七起來 | 七起来 | |
45 | Kunoichi | 女忍者 | 女忍者 | |
46 | Ninja | 忍者 | 忍者 | |
47 | Jelly 27 | 果凍 27 | 果冻 27 | |
48 | Angry Bear | 暴怒棕熊 | 暴怒棕熊 | |
49 | Poseidon | 海神 | 海神 | |
50 | Dancing Lion | 跳跳獅 | 跳跳狮 | |
51 | Medusa | 美杜莎 | 美杜莎 | |
52 | Medea | 美狄亞 | 美狄亚 | |
53 | Neon Circle | 霓虹圓 | 霓虹圆 | |
55 | Get High | 嗨起來 | 嗨起来 | |
56 | Cowboy | 西部牛仔 | 西部牛仔 | |
58 | The Little Match Girl | 賣火柴的小女孩 | 卖火柴的小女孩 | |
59 | Mystery Panda | 秘林熊貓 | 秘林熊猫 | |
60 | Hip Hop Monkey | 嘻哈金剛 | 嘻哈金刚 | |
61 | Book of Gold | 黃金之書 | 黄金之书 | |
65 | Tai Chi | 太極 | 太极 | |
66 | Golden Leaf Clover | 金色幸運草 | 金色幸运草 | |
68 | Wizard Store Gold | 巫師商店黃金版 | 巫师商店黄金版 | |
70 | Rat's Money | 鼠來寶 | 鼠来宝 | |
72 | Songkran | 潑水節 | 泼水节 | |
73 | Elf Archer | 精靈射手 | 精灵射手 | |
76 | Bear Kingdom | 小熊王國 | 小熊王国 | |
78 | Royal 7777 | 皇家 7777 | 皇家 7777 | |
81 | Dragon King2 | 龍王 2 | 龙王 2 | |
82 | Pharaoh II | 法老王 II | 法老王 II | |
90 | Dragon Fight | 龍行天下 | 龙行天下 | |
100 | Roma | 羅馬競技場 | 罗马竞技场 | |
113 | Chin Shi Huang | 秦皇傳說 | 秦皇传说 | |
121 | Legend of Lu Bu | 戰神呂布 | 战神吕布 | |
123 | Jurassic Treasure | 侏羅紀寶藏 | 侏罗纪宝藏 | 2024.11 |
2001 | Energy Combo | 能量外星人 | 能量外星人 |
1-3 老虎機遊戲代碼(遊戲畫面只限直式)
代碼 | en-US | zh-TW | zh-CN | 最後新增 |
---|---|---|---|---|
117 | Rich Mahjong | 麻將發了 | 麻将发了 | |
114 | Caishen Fortunes | 聚寶財神 | 聚宝财神 | |
119 | Dragon Legend | 魔龍傳奇 | 魔龙传奇 | |
75 | Luchadors | 黃金摔角手 | 黃金摔角手 | 2024.01 |
120 | Caishen Coming | 有請財神 | 有請財神 | 2024.01 |
125 | Fortune Gems 4 | 迦羅寶石4 | 迦罗宝石4 | 2024.11 |
128 | Super Ace 2 | 超級王牌2 | 超级王牌2 | 2024.11 |
116 | Fortune of Aztecs | 勇闖黃金城 | 勇闯黄金城 | 2024.11 |
118 | Rich Mahjong 2 | 麻將發了2 | 麻将发了2 | 2024.11 |
122 | Lucky Dog | 狗來富 | 狗来富 | 2024.11 |
126 | Night Market 3 | 逛夜市3 | 逛夜市3 | 2024.12 |
127 | Chinese New Year 3 | 大過年3 | 大过年3 | 2024.12 |
1-4 老虎機遊戲代碼(直橫式皆有)
代碼 | en-US | zh-TW | zh-CN | 最後新增 |
---|---|---|---|---|
111 | Happy Farm | 開心農場 | 开心农场 | |
112 | Power of Thor | 雷神之錘 | 雷神之锤 |
1-5 捕魚機遊戲代碼(遊戲畫面只限橫式)
代碼 | en-US | zh-TW | zh-CN | 最後新增 |
---|---|---|---|---|
3001 | Ocean Emperor | 八爪天下海霸王 | 八爪天下海霸王 | |
3002 | FuWa Fishing | 福娃捕魚 | 福娃捕鱼 |
1-6 街機遊戲代碼(遊戲畫面只限橫式)
代碼 | en-US | zh-TW | zh-CN | 最後新增 |
---|---|---|---|---|
5001 | Crown 5PK | 皇冠5PK | 皇冠5PK |
2. 子遊戲代碼
2-1 說明
本子遊戲代碼供歷史紀錄獲取後的識別用
2-2 老虎機子遊戲代碼
代碼 | 子遊戲名稱 | 最後新增 |
---|---|---|
0 | 一般 (Spin) | |
1 | 免費 | |
2 | 比倍 | |
3 | Jackpot | |
4 | 重轉 | |
5 | 選擇 | |
6 | 連鎖 | |
7 | 消除 | |
99 | 特色 |
2-3 捕魚機子遊戲代碼
代碼 | 子遊戲名稱 | 最後新增 |
---|---|---|
3000 | 一般 (射擊) | |
3001 | 龍王砲 | |
3002 | 砲返現 ( 龍王 ) | |
3003 | 元寶牆 | |
3004 | 鑽頭炮 | |
3005 | 砲返現 ( 鑽頭 ) | |
99 | 特色 | |
100 | Jackpot |
附錄 B - 幣別代碼表
版本: v1.4.0
代碼 | 幣別名稱 | 比例備註 | 最後新增 |
---|---|---|---|
NT | 新台幣 | ||
HK | 港元 | ||
IDR | 印尼盾 | 1 : 1000 | |
JPY | 日圓 | ||
KRW | 韓圓 | ||
MYR | 馬幣 | ||
RMB | 人民幣 | ||
SGD | 新加坡元 | ||
THB | 泰銖 | ||
USA | 美元 | ||
MMK | 緬甸緬元 | ||
VND | 越南盾 | 1 : 1000 | |
INR | 印度盧比 | ||
PHP | 披索 | ||
EUR | 歐元 | ||
GBP | 英鎊 | ||
USDT | 泰達幣 | ||
MYR2 | 馬幣 100 | 1 : 0.01 | |
RSG01 | 新台幣 100 | 1 : 0.01 | |
RSG02 | 新台幣 130 | 1 : 1/130 | |
AUD | 澳大利亞元 | 2024.08 | |
BRL | 巴西雷亞爾 | 2024.08 | |
LAK | 寮國基普 | 1 : 1000 | 2024.08 |
NGN | 奈及利亞奈拉 | 2024.08 | |
PKR | 巴基斯坦盧比 | 2024.08 | |
ZAR | 南非蘭特 | 2024.08 | |
MXN | 墨西哥比索 | 2024.08 | |
USDK | 美元 1000 | 1 : 0.001 | 2024.08 |
BDT | 孟加拉塔卡 | 2024.08 | |
JPY2 | 日圓 130 | 1 : 1/130 | 2025.03 |
VNDO | 越南盾原幣 | 2025.03 | |
RSG03 | 泰銖 5000 | 1 : 1/5000 | 2025.03 |
LAKO | 寮國基普原幣 | 2025.03 |
附錄 C - 語系代碼表
版本: v1.1.0
代碼 | 語言名稱 | 最後新增 |
---|---|---|
en-US | 英文 | |
zh-TW | 繁體中文 | |
zh-CN | 簡體中文 | |
th-TH | 泰文 | |
ko-KR | 韓文 | |
ja-JP | 日文 | |
en-MY | 緬甸文 | |
id-ID | 印尼文 | |
vi-VN | 越南文 | 2021.11 |
附錄 D - 版本說明
1.13.0
- 新增四種幣別
- 日圓 130
- 越南盾原幣
- 泰銖 5000
- 寮國基普原幣
1.12.0
- 雷神之錘支援直橫式
1.11.0
1.10.0
1.9.0
1.8.0
- 新增 3-2 發送請求 常見問題清單
- 新增回首頁連結
1.7.0
- 將 API 文件由 PDF 版本轉為網頁版本,本版本為網頁版初始版