Quellcode durchsuchen

大厅文档完善

qingjie vor 5 Monaten
Ursprung
Commit
8d2a8138bb

BIN
pic/hall_workflow_en.png


BIN
pic/hall_workflow_zh.png


+ 1 - 1
seamless/en/_sidebar.md

@@ -15,6 +15,7 @@
    * [Get round detail](en/round_detail)
    * [Get player total profit](en/total_profit_or_loss)
    * [Get free game count](en/free_count)
+   * [Game Lobby Access](en/lobby)
 * [Appendix](en/appendice)
    * [List of Transaction Columns](en/Transaction_data)
    * [Currencies List](en/currency)
@@ -23,7 +24,6 @@
    * [Status Code](en/mode_code)
    * [Game Mode](en/game_mode)
    * [Game Type](en/game_type)
-   * [Game Hall Access](en/lobby)
    * [Error Code](en/errorcode)
 
    

+ 55 - 16
seamless/en/lobby.md

@@ -1,27 +1,66 @@
-# <font > Game hall access </font>
+# <font > Game Lobby access </font>
 ## Description 
 
-> This section describes the process for connecting to the game hall
+## Game Lobby Access Addresses
+```shell
+Staging environment address: https://hall.stag-topgame.com
+Production environment address: 
+```
 
 
-## Step
-### 1. Request key
+## Game Lobby Integration Workflow
+![游戏大厅](../../pic/hall_workflow_en.png)
 
-- Obtain the key by  calling interface 
-> Interface: [api/game/getKey](./keys.md)
+## Access Steps
+### 1. Initiate URL Request to  ([api/game/getKey](/en/keys.md)) interface to obtain key
 
+#### Request Parameters
+| Name     | Type     | Required    |     Description        | 
+| -------- | -------- | -------- |    -------- |  
+| cert     | string     |   Y |     Security code |
+| user      |string (30) |  Y |      Player account|
+| extension1 | string(20) | Y |      Agent account |
 
-### 2、Call interface instance:
-- calling interface url + Jump parameter
-> https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
+#### Request Example
+```shell
+Content-Type: application/x-www-form-urlencoded
+Method: POST
+Endpoint:https://{api_address}/api/game/getKey
 
-Parameter description:
 
+Example
+curl -X POST 'https://api.stag-topgame.com/api/game/getKey' -F 'cert=v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y' -F 'user=adminw_qo68801mnj25o2nqu1u' -F 'extension1=adminweb'
+```
 
-| Param     | Type     |    Description        | 
-| -------- | -------- |   -------- |  
-| tt    | string     |      The key is obtained by getting the key interface ( [api/game/getKey](en/keys.md) ) |
-|lang| string| The language to display  |
+#### Response Parameters
+| Name     | Type     | Required    |     Description        | 
+| -------- | -------- | -------- |    -------- |  
+| status   | string     |   Y |     Status code (1 = success, others = failure)|
+|key    |string (30) |  Y |     Secret key|
 
-### 3、Hall Example
-![Game Hall](../../pic/lobby.png)
+#### Response Example
+```shell
+{
+  "status": 1, 
+  "key": "3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A", # Secret key
+ 
+}
+```
+
+
+### 2. Initiate URL Request to Access Lobby Page
+- Use the secret key obtained in Step 1 to make a GET request
+#### Request Parameters
+| Name      | Type     |    Description        | 
+| -------- | -------- |   --------		 |  
+| tt     | string     |  Key obtained from( [api/game/getKey](/en/keys.md) )interface |
+| lang   | string     | Language code (e.g. en, zh, id). Default: en |
+
+#### Request Example
+```shell
+ https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A&lang=en
+```
+
+
+#### Lobby Page Response Example
+![Game Lobby](../../pic/lobby.png)

+ 1 - 1
seamless/zh/_sidebar.md

@@ -15,6 +15,7 @@
    * [后台游戏细单](zh/round_detail)
    * [玩家总输赢](zh/total_profit_or_loss)
    * [免费游戏剩余次数](zh/free_count)
+   * [游戏大厅接入](zh/lobby)
 * [附录](zh/appendice)
    * [交易资料名称](zh/Transaction_data)
    * [货币类型列表](zh/currency)
@@ -23,6 +24,5 @@
    * [状态代码](zh/mode_code)
    * [游戏模式](zh/game_mode)
    * [游戏类型](zh/game_type)
-   * [游戏大厅接入](zh/lobby)
    * [错误码](zh/errorcode)
   

+ 54 - 12
seamless/zh/lobby.md

@@ -1,29 +1,71 @@
 # <font > 游戏大厅接入 </font>
 ## 描述 
 
-> 介绍接入游戏大厅的流程
+## 接入游戏大厅地址
+```shell
+对接环境地址: https://hall.stag-topgame.com
+正式环境地址: 
+```
 
 
-## 步骤
-### 一、请求key
+## 接入游戏大厅流程
+![游戏大厅](../../pic/hall_workflow_zh.png)
 
-- 通过获取密钥接口,来获取key
+## 接入步骤
+### 一、 发起url请求 [api/game/getKey](/zh/keys.md) 接口获取密钥
 
-> 接口: [api/game/getKey](./keys.md)
+#### 获取密钥发起请求参数说明
+| 名称     | 类型     | 必要    |     描述        | 
+| -------- | -------- | -------- |    -------- |  
+| cert     | string     |   Y |     安全代码 |
+| user      |string (30) |  Y |      玩家账号|
+| extension1 | string(20) | Y |      代理帐号 |
 
+#### 获取密钥发起请求示例
+```shell
+Content-Type: application/x-www-form-urlencoded
+请求方法: POST
+请求地址:https://{api地址}/api/game/getKey
 
 
-### 二、调用接口实例:
-- 调用接口url + 跳转参数
-> https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
+示例
+curl -X POST 'https://api.stag-topgame.com/api/game/getKey' -F 'cert=v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y' -F 'user=adminw_qo68801mnj25o2nqu1u' -F 'extension1=adminweb'
+```
 
-- 参数说明:
+#### 获取密钥返回结果字段说明
+| 名称     | 类型     | 必要    |     描述        | 
+| -------- | -------- | -------- |    -------- |  
+| status   | string     |   Y |     状态代码 1表示成功,其他表示失败|
+|key    |string (30) |  Y |     密钥|
 
+#### 获取密钥返回结果示例示例
+```shell
+{
+  "status": 1, 
+  "key": "3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A", # 密钥
+ 
+}
+```
+
+
+
+
+
+
+
+### 二、发起url请求获取大厅页面
+- 通过第一步获取密钥(key),发起url GET请求就直接能获取大厅页面
+#### 请求参数字段说明
 | 名称      | 类型     |    描述        | 
 | -------- | -------- |   --------		 |  
-| tt     | string     | 通过获取密钥接口( [api/game/getKey](zh/keys.md) )得到的key |
-| lang   | string     | 要显示的语言  |
+| tt     | string     | 通过获取密钥接口( [api/game/getKey](/zh/keys.md) )得到的key |
+| lang   | string     | 语言 例如 en,zh,id 默认en |
+
+#### 获取大厅页面请求示例
+```shell
+ https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A&lang=en
+```
 
 
-### 三、大厅展示
+#### 返回大厅页面示例
 ![游戏大厅](../../pic/lobby.png)

+ 1 - 1
transfer/en/_sidebar.md

@@ -18,6 +18,7 @@
    * [Get player total profit](en/total_profit_or_loss)
    * [Get round detail](en/round_detail)
    * [Get free game count](en/free_count)
+   * [Game Lobby Access](en/lobby)
 * [Appendix](en/appendice)
    * [List of Transaction Columns](en/Transaction_data)
    * [Currencies List](en/currency)
@@ -26,7 +27,6 @@
    * [Status Code](en/mode_code)
    * [Game Mode](en/game_mode)
    * [Game Type](en/game_type) 
-   * [Game Hall Access](en/lobby)
    * [Error Code](en/errorcode)
    
 

+ 55 - 16
transfer/en/lobby.md

@@ -1,27 +1,66 @@
-# <font > Game hall access </font>
+# <font > Game Lobby access </font>
 ## Description 
 
-> This section describes the process for connecting to the game hall
+## Game Lobby Access Addresses
+```shell
+Staging environment address: https://hall.stag-topgame.com
+Production environment address: 
+```
 
 
-## Step
-### 1. Request key
+## Game Lobby Integration Workflow
+![游戏大厅](../../pic/hall_workflow_en.png)
 
-- Obtain the key by  calling interface 
-> Interface: [api/game/getKey](./keys.md)
+## Access Steps
+### 1. Initiate URL Request to  ([api/game/getKey](/en/keys.md)) interface to obtain key
 
+#### Request Parameters
+| Name     | Type     | Required    |     Description        | 
+| -------- | -------- | -------- |    -------- |  
+| cert     | string     |   Y |     Security code |
+| user      |string (30) |  Y |      Player account|
+| extension1 | string(20) | Y |      Agent account |
 
-### 2、Call interface instance:
-- calling interface url + Jump parameter
-> https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
+#### Request Example
+```shell
+Content-Type: application/x-www-form-urlencoded
+Method: POST
+Endpoint:https://{api_address}/api/game/getKey
 
-Parameter description:
 
+Example
+curl -X POST 'https://api.stag-topgame.com/api/game/getKey' -F 'cert=v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y' -F 'user=adminw_qo68801mnj25o2nqu1u' -F 'extension1=adminweb'
+```
 
-| Param     | Type     |    Description        | 
-| -------- | -------- |   -------- |  
-| tt    | string     |      The key is obtained by getting the key interface ( [api/game/getKey](en/keys.md) ) |
-|lang| string| The language to display  |
+#### Response Parameters
+| Name     | Type     | Required    |     Description        | 
+| -------- | -------- | -------- |    -------- |  
+| status   | string     |   Y |     Status code (1 = success, others = failure)|
+|key    |string (30) |  Y |     Secret key|
 
-### 3、Hall Example
-![Game Hall](../../pic/lobby.png)
+#### Response Example
+```shell
+{
+  "status": 1, 
+  "key": "3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A", # Secret key
+ 
+}
+```
+
+
+### 2. Initiate URL Request to Access Lobby Page
+- Use the secret key obtained in Step 1 to make a GET request
+#### Request Parameters
+| Name      | Type     |    Description        | 
+| -------- | -------- |   --------		 |  
+| tt     | string     |  Key obtained from( [api/game/getKey](/en/keys.md) )interface |
+| lang   | string     | Language code (e.g. en, zh, id). Default: en |
+
+#### Request Example
+```shell
+ https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A&lang=en
+```
+
+
+#### Lobby Page Response Example
+![Game Lobby](../../pic/lobby.png)

+ 1 - 1
transfer/zh/_sidebar.md

@@ -17,6 +17,7 @@
    * [玩家总输赢](zh/total_profit_or_loss)
    * [游戏细单](zh/round_detail)
    * [免费游戏剩余次数](zh/free_count)
+   * [游戏大厅接入](zh/lobby)
 * [附录](zh/appendice)
    * [交易资料名称](zh/Transaction_data)
    * [货币类型列表](zh/currency)
@@ -25,7 +26,6 @@
    * [状态代码](zh/mode_code)
    * [游戏模式](zh/game_mode)
    * [游戏类型](zh/game_type)
-   * [游戏大厅接入](zh/lobby)
    * [错误码](zh/errorcode)
 
 

+ 54 - 12
transfer/zh/lobby.md

@@ -1,29 +1,71 @@
 # <font > 游戏大厅接入 </font>
 ## 描述 
 
-> 介绍接入游戏大厅的流程
+## 接入游戏大厅地址
+```shell
+对接环境地址: https://hall.stag-topgame.com
+正式环境地址: 
+```
 
 
-## 步骤
-### 一、请求key
+## 接入游戏大厅流程
+![游戏大厅](../../pic/hall_workflow_zh.png)
 
-- 通过获取密钥接口,来获取key
+## 接入步骤
+### 一、 发起url请求 [api/game/getKey](/zh/keys.md) 接口获取密钥
 
-> 接口: [api/game/getKey](./keys.md)
+#### 获取密钥发起请求参数说明
+| 名称     | 类型     | 必要    |     描述        | 
+| -------- | -------- | -------- |    -------- |  
+| cert     | string     |   Y |     安全代码 |
+| user      |string (30) |  Y |      玩家账号|
+| extension1 | string(20) | Y |      代理帐号 |
 
+#### 获取密钥发起请求示例
+```shell
+Content-Type: application/x-www-form-urlencoded
+请求方法: POST
+请求地址:https://{api地址}/api/game/getKey
 
 
-### 二、调用接口实例:
-- 调用接口url + 跳转参数
-> https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
+示例
+curl -X POST 'https://api.stag-topgame.com/api/game/getKey' -F 'cert=v8VMKKzlPpD0te4rX99Hgefs3PQrBFWJKiuUqg6Y' -F 'user=adminw_qo68801mnj25o2nqu1u' -F 'extension1=adminweb'
+```
 
-- 参数说明:
+#### 获取密钥返回结果字段说明
+| 名称     | 类型     | 必要    |     描述        | 
+| -------- | -------- | -------- |    -------- |  
+| status   | string     |   Y |     状态代码 1表示成功,其他表示失败|
+|key    |string (30) |  Y |     密钥|
 
+#### 获取密钥返回结果示例示例
+```shell
+{
+  "status": 1, 
+  "key": "3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A", # 密钥
+ 
+}
+```
+
+
+
+
+
+
+
+### 二、发起url请求获取大厅页面
+- 通过第一步获取密钥(key),发起url GET请求就直接能获取大厅页面
+#### 请求参数字段说明
 | 名称      | 类型     |    描述        | 
 | -------- | -------- |   --------		 |  
-| tt     | string     | 通过获取密钥接口( [api/game/getKey](zh/keys.md) )得到的key |
-| lang   | string     | 要显示的语言  |
+| tt     | string     | 通过获取密钥接口( [api/game/getKey](/zh/keys.md) )得到的key |
+| lang   | string     | 语言 例如 en,zh,id 默认en |
+
+#### 获取大厅页面请求示例
+```shell
+ https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A6C7B77746366835F7250C896919F3B251654E75509490125E4966E52E8AB61D2A62FB40C0AEEFFC08C0EBCBA6AAEFAE4A&lang=en
+```
 
 
-### 三、大厅展示
+#### 返回大厅页面示例
 ![游戏大厅](../../pic/lobby.png)