Forráskód Böngészése

完善大厅对接文档

qingjie 5 hónapja
szülő
commit
804dedba45
5 módosított fájl, 185 hozzáadás és 12 törlés
  1. BIN
      pic/lobby.png
  2. 46 2
      seamless/en/lobby.md
  3. 47 4
      seamless/zh/lobby.md
  4. 45 2
      transfer/en/lobby.md
  5. 47 4
      transfer/zh/lobby.md

BIN
pic/lobby.png


+ 46 - 2
seamless/en/lobby.md

@@ -9,10 +9,54 @@
 
 - Calling interface : url:https://hall.stag-topgame.com
 
+
+- Parameter analysis of successful results
+
+| Name     | Type     | Required    |     Description        | 
+| -------- | -------- | -------- |    -------- |  
+| gameicourl    | string     |   Y |     Request game entry icon address |
+| gameurl| string| Game link address  |
+| gamelist.name   |string |    Game Name |
+| gamelist.gid| string(20) |   Unique id to enter the game  |
+| gamelist.gametype   |string |    Game Type |
+| gamelist.hot| int |  1 represents the tag of popular games,  0 does not   |
+| gamelist.new| int |  1 represents the new game tag, 0 does not |
+
+   
+- Successful  Result
+```
+{
+	"gameicourl": "http://127.0.0.1:8000/gameicon",
+	"gamelist": [
+		{
+			"gid": "be001",
+			"name": "Dragon Stash",
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
+		},
+		{
+			"gid": "be002",
+			"name": "Jungle Fruit",
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
+		}
+	]
+}
+```
+
 ### 2、Call interface instance:
 - calling interface url + Jump parameter
 > https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
 
 Parameter description:
-    Parameter tt:The key is obtained by getting the key interface (api/game/getKey)
-    Parameter lang: The language to display
+
+
+| Param     | Type     |    Description        | 
+| -------- | -------- |   -------- |  
+| tt    | string     |      The key is obtained by getting the key interface (api/game/getKey) |
+|lang| string| The language to display  |
+
+### 3、Hall Example
+![Game Hall](../../pic/lobby.png)

+ 47 - 4
seamless/zh/lobby.md

@@ -9,10 +9,53 @@
 
 - 调用接口url:https://hall.stag-topgame.com
 
-### 三、调用接口实例:
+-  成功结果的参数解析
+  
+| 名称     | 类型     |    描述        | 
+| -------- | -------- |   -------- |  
+| gameicourl    | string     |      请求游戏入口icon地址 |
+| gameurl| string| 游戏跳转地址  |
+| gamelist.name   |string |    游戏名称 |
+| gamelist.gid| string(20) |   进入游戏的唯一id  |
+| gamelist.gametype   |string |    游戏类型 |
+| gamelist.hot| int |  1 表示热门游戏标签, 0 则不是    |
+| gamelist.new| int |  1 表示新游戏标签, 0 则不是  |
+
+- 成功的结果
+```
+{
+	"gameicourl": "http://127.0.0.1:8000/gameicon",
+	"gamelist": [
+		{
+			"gid": "be001",
+			"name": "Dragon Stash",
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
+		},
+		{
+			"gid": "be002",
+			"name": "Jungle Fruit",
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
+		}
+	],
+	 "gameurl": "https://game.stag-topgame.com"
+}
+``` 
+
+### 二、调用接口实例:
 - 调用接口url + 跳转参数
 > https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
 
-参数说明:
-    参数tt:通过获取密钥接口(api/game/getKey)得到的key
-    参数lang:要显示的语言
+- 参数说明:
+
+| 名称     | 类型     |    描述        | 
+| -------- | -------- |   -------- |  
+| tt    | string     |      通过获取密钥接口(api/game/getKey)得到的key |
+|lang| string| 要显示的语言  |
+
+
+### 三、大厅展示
+![游戏大厅](../../pic/lobby.png)

+ 45 - 2
transfer/en/lobby.md

@@ -9,10 +9,53 @@
 
 - Calling interface : url:https://hall.stag-topgame.com
 
+- Parameter analysis of successful results
+
+| Name     | Type     | Required    |     Description        | 
+| -------- | -------- | -------- |    -------- |  
+| gameicourl    | string     |   Y |     Request game entry icon address |
+| gameurl| string| Game link address  |
+| gamelist.name   |string |    Game Name |
+| gamelist.gid| string(20) |   Unique id to enter the game  |
+| gamelist.gametype   |string |    Game Type |
+| gamelist.hot| int |  1 represents the tag of popular games,  0 does not   |
+| gamelist.new| int |  1 represents the new game tag, 0 does not |
+
+   
+- Successful  Result
+```
+{
+	"gameicourl": "http://127.0.0.1:8000/gameicon",
+	"gamelist": [
+		{
+			"gid": "be001",
+			"name": "Dragon Stash",
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
+		},
+		{
+			"gid": "be002",
+			"name": "Jungle Fruit",
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
+		}
+	]
+}
+```
+
 ### 2、Call interface instance:
 - calling interface url + Jump parameter
 > https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
 
 Parameter description:
-    Parameter tt:The key is obtained by getting the key interface (api/game/getKey)
-    Parameter lang: The language to display
+
+
+| Param     | Type     |    Description        | 
+| -------- | -------- |   -------- |  
+| tt    | string     |      The key is obtained by getting the key interface (api/game/getKey) |
+|lang| string| The language to display  |
+
+### 3、Hall Example
+![Game Hall](../../pic/lobby.png)

+ 47 - 4
transfer/zh/lobby.md

@@ -9,10 +9,53 @@
 
 - 调用接口url:https://hall.stag-topgame.com
 
-### 三、调用接口实例:
+-  成功结果的参数解析
+  
+| 名称     | 类型     |    描述        | 
+| -------- | -------- |   -------- |  
+| gameicourl    | string     |      请求游戏入口icon地址 |
+| gameurl| string| 游戏跳转地址  |
+| gamelist.name   |string |    游戏名称 |
+| gamelist.gid| string(20) |   进入游戏的唯一id  |
+| gamelist.gametype   |string |    游戏类型 |
+| gamelist.hot| int |  1 表示热门游戏标签, 0 则不是    |
+| gamelist.new| int |  1 表示新游戏标签, 0 则不是  |
+
+- 成功的结果
+```
+{
+	"gameicourl": "http://127.0.0.1:8000/gameicon",
+	"gamelist": [
+		{
+			"gid": "be001",
+			"name": "Dragon Stash",
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
+		},
+		{
+			"gid": "be002",
+			"name": "Jungle Fruit",
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
+		}
+	],
+	 "gameurl": "https://game.stag-topgame.com"
+}
+``` 
+
+### 二、调用接口实例:
 - 调用接口url + 跳转参数
 > https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
 
-参数说明:
-    参数tt:通过获取密钥接口(api/game/getKey)得到的key
-    参数lang:要显示的语言
+- 参数说明:
+
+| 名称     | 类型     |    描述        | 
+| -------- | -------- |   -------- |  
+| tt    | string     |      通过获取密钥接口(api/game/getKey)得到的key |
+|lang| string| 要显示的语言  |
+
+
+### 三、大厅展示
+![游戏大厅](../../pic/lobby.png)