qingjie il y a 5 mois
Parent
commit
4b4cc2e5ca

+ 1 - 1
seamless/en/_sidebar.md

@@ -23,6 +23,6 @@
    * [Status Code](en/mode_code)
    * [Game Mode](en/game_mode)
    * [Game Type](en/game_type)
-
+   * [Game Hall Access](en/lobby)
 
    

+ 71 - 2
seamless/en/game_list.md

@@ -47,12 +47,16 @@
 		{
 			"gid": "be001",
 			"name": "Dragon Stash",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
 		},
 		{
 			"gid": "be002",
 			"name": "Jungle Fruit",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
 		}
 	]
 }
@@ -68,6 +72,71 @@
 
 
 
+##    Login
+
+###  Descripti on
+>Invoke this method with your “Key” (returned by GetKey API) to launch game.
+
+>Game return description: After the game is closed, the return address (return_url= the parameter of the return address), if not filled in, the game has no return button.
+
+
+##    Method URL
+```
+http://{BesoftFront}/?key=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701
+568BA675BDA3C46BCA64D243007F87C86119329271708&gid=be001&lang=en&return_url=https://returnyoururl.com
+
+```
+
+> New interface: If you need to close the current window directly, please use the window.open mode to open, and do not need to pass the return_url
+
+
+
+
+> New interface: If the parameter return_url is added, please encode the parameter in URLEncoding mode
+
+
+
+
+> Embedded interface: If it is embedded, please listen for this message notification (closeMessage), the game manufacturer closes the game's call interface
+
+
+```
+{
+   window.parent.postMessage("closeMessage", "*")
+}
+
+
+```
+
+
+## Request Parameter
+
+| Name     | Type    | Required    |   Description       | 
+| -------- | -------- | -------- |    -------- |  
+| acc     | String(30)     |   Y |     User ID |
+| key     |string(86) |  Y |1.Key value returned by “GetKey”    ,   2.Please do URLEncoding on it while using the HTTP GET method) |
+| aid | string(20) | Y |      Agent Id  |
+| nick | string (50) | Y |      User name Only Support 16 Unicode characters |
+| gid| Integer | Y|     input gameId as default launch game ; if blank, go to lobby. |
+| lang| string | Y|     default is cn   ,   cn : simplified Chinese     ,   en : english |
+| return_url | string | N |      return_url=Game off return address,Please encode the parameters in URLEncoding mode  |
+
+##     Return Result
+
+###  Successful Result
+
+>Redirect Browser to game hall page
+
+###  Failed Result
+
+>The game interface displays the corresponding error message.
+
+
+
+
+
+
+
 ## Method for piecing together the address of the game entrance icon request
 > gameicourl+/+ gid+"_game_icon_"+Size+"_"+"Language encoding"+.png"
 

+ 18 - 0
seamless/en/lobby.md

@@ -0,0 +1,18 @@
+# <font > Game hall access </font>
+## Description 
+
+> This section describes the process for connecting to the game hall
+
+
+## Step
+### 1.Get the games list page
+
+- Calling interface : url:https://hall.stag-topgame.com
+
+### 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

+ 2 - 0
seamless/zh/_sidebar.md

@@ -23,3 +23,5 @@
    * [状态代码](zh/mode_code)
    * [游戏模式](zh/game_mode)
    * [游戏类型](zh/game_type)
+   * [游戏大厅接入](zh/lobby)
+  

+ 62 - 2
seamless/zh/game_list.md

@@ -50,12 +50,16 @@
 		{
 			"gid": "be001",
 			"name": "Dragon Stash",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
 		},
 		{
 			"gid": "be002",
 			"name": "Jungle Fruit",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
 		}
 	]
 }
@@ -72,6 +76,62 @@
 
 
 
+
+##  进入游戏
+
+### 描述
+>使用“key”(由 getkey api 返回)调用此方法以启动游戏。
+
+>游戏返回说明:游戏关闭后,返回的地址(return_url=返回地址的参数),如果不填写,游戏没有返回按钮。
+
+
+## 网址
+```
+http://{BesoftFront}/?key=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701
+568BA675BDA3C46BCA64D243007F87C86119329271708&gid=be001&lang=en&return_url=https://returnyoururl.com
+
+```
+>新开界面:如果需要直接关闭当前窗口,请使用window.open方式打开,并且不需要传入return_url
+
+
+>新开界面:如果加入return_url参数,请以URLEncoding方式编码参数
+
+
+>内嵌界面:如果是内嵌请监听此消息通知(closeMessage),游戏厂商关闭游戏的调用接口
+```
+{
+   window.parent.postMessage("closeMessage", "*")
+}
+
+```
+
+
+## 请求参数
+
+| 名称     | 类型     | 必要    |     描述        | 
+| -------- | -------- | -------- |    -------- |  
+| acc     | String(30)     |   Y |     用户ID |
+| key     |string(86) |  Y |从 getKey 接口拿到的 key。若使用 HTTP GET 方法,请以 URLEncoding 编码参数|
+| aid | string(20) | Y |      代理帐号  |
+| nick | string (50) | Y |     用户名,最多支持 16 个 Unicode 字节  |
+| gid | Integer | Y |      预设登入的游戏 ID ;  |
+| lang | string | Y |      默认值为简中 (简中 英文) |
+| return_url | string | N |      return_url=游戏关闭的返回地址 ,请以URLEncoding方式编码参数|
+##  返回结果
+
+### 成功的结果
+
+>Redirect Browser to gamehall page; 导引至游戏页面
+
+### 失败的结果
+
+>游戏界面显示相应的错误信息
+
+
+
+
+
+
 ##  请求游戏入口icon地址的拼接方法
 > gameicourl+/+ gid+"_game_icon_"+尺寸+"_"+语言编码+".png"
 

+ 18 - 0
seamless/zh/lobby.md

@@ -0,0 +1,18 @@
+# <font > 游戏大厅接入 </font>
+## 描述 
+
+> 介绍接入游戏大厅的流程
+
+
+## 步骤
+### 一、获取游戏列表页面
+
+- 调用接口url:https://hall.stag-topgame.com
+
+### 三、调用接口实例:
+- 调用接口url + 跳转参数
+> https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
+
+参数说明:
+    参数tt:通过获取密钥接口(api/game/getKey)得到的key
+    参数lang:要显示的语言

+ 2 - 1
transfer/en/_sidebar.md

@@ -25,7 +25,8 @@
    * [Game result](en/result)
    * [Status Code](en/mode_code)
    * [Game Mode](en/game_mode)
-   * [Game Type](en/game_type)
+   * [Game Type](en/game_type) 
+   * [Game Hall Access](en/lobby)
    
 
 

+ 69 - 3
transfer/en/game_list.md

@@ -47,12 +47,16 @@
 		{
 			"gid": "be001",
 			"name": "Dragon Stash",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
 		},
 		{
 			"gid": "be002",
 			"name": "Jungle Fruit",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
 		}
 	]
 }
@@ -67,11 +71,73 @@
 ```
 
 
+##    Login
+
+###  Descripti on
+>Invoke this method with your “Key” (returned by GetKey API) to launch game.
+
+>Game return description: After the game is closed, the return address (return_url= the parameter of the return address), if not filled in, the game has no return button.
+
+
+##    Method URL
+```
+http://{BesoftFront}/?key=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701
+568BA675BDA3C46BCA64D243007F87C86119329271708&gid=be001&lang=en&return_url=https://returnyoururl.com
+
+```
+
+> New interface: If you need to close the current window directly, please use the window.open mode to open, and do not need to pass the return_url
+
+
+
+
+> New interface: If the parameter return_url is added, please encode the parameter in URLEncoding mode
+
+
+
+
+> Embedded interface: If it is embedded, please listen for this message notification (closeMessage), the game manufacturer closes the game's call interface
+
+
+```
+{
+   window.parent.postMessage("closeMessage", "*")
+}
+
+
+```
+
+
+## Request Parameter
+
+| Name     | Type    | Required    |   Description       | 
+| -------- | -------- | -------- |    -------- |  
+| acc     | String(30)     |   Y |     User ID |
+| key     |string(86) |  Y |1.Key value returned by “GetKey”    ,   2.Please do URLEncoding on it while using the HTTP GET method) |
+| aid | string(20) | Y |      Agent Id  |
+| nick | string (50) | Y |      User name Only Support 16 Unicode characters |
+| gid| Integer | Y|     input gameId as default launch game ; if blank, go to lobby. |
+| lang| string | Y|     default is cn   ,   cn : simplified Chinese     ,   en : english |
+| return_url | string | N |      return_url=Game off return address,Please encode the parameters in URLEncoding mode  |
+
+##     Return Result
+
+###  Successful Result
+
+>Redirect Browser to game hall page
+
+###  Failed Result
+
+>The game interface displays the corresponding error message.
+
+
+
+
+
 
 ## Method for piecing together the address of the game entrance icon request
 > gameicourl+/+ gid+"_game_icon_"+Size+"_"+"Language encoding"+.png"
 
-
 ##  Icon Get example
 ### English
 ```

+ 0 - 1
transfer/en/keys.md

@@ -18,7 +18,6 @@
 | -------- | -------- | -------- |    -------- |  
 | cert     | string     |   Y |     security code |
 | user      |string (30) |  Y |      unique user id (only allow lower case a-z and 0-9) BY WEBSITE)|
-| userName    |String(50) |  Y |      1. A display name in BESOFT Fish Games.   ,   2. Only Support 16 Unicode characters|
 | extension1 | string(20) | Y |      agent Id from ARS,belong to website |
 
 

+ 18 - 0
transfer/en/lobby.md

@@ -0,0 +1,18 @@
+# <font > Game hall access </font>
+## Description 
+
+> This section describes the process for connecting to the game hall
+
+
+## Step
+### 1.Get the games list page
+
+- Calling interface : url:https://hall.stag-topgame.com
+
+### 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

+ 1 - 0
transfer/zh/_sidebar.md

@@ -25,6 +25,7 @@
    * [状态代码](zh/mode_code)
    * [游戏模式](zh/game_mode)
    * [游戏类型](zh/game_type)
+   * [游戏大厅接入](zh/lobby)
 
 
 

+ 59 - 2
transfer/zh/game_list.md

@@ -50,12 +50,16 @@
 		{
 			"gid": "be001",
 			"name": "Dragon Stash",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 0
 		},
 		{
 			"gid": "be002",
 			"name": "Jungle Fruit",
-			"gametype": "1"
+			"gametype": "1",
+			"hot": 1,
+			"new": 1
 		}
 	]
 }
@@ -72,6 +76,59 @@
 
 
 
+##  进入游戏
+
+### 描述
+>使用“key”(由 getkey api 返回)调用此方法以启动游戏。
+
+>游戏返回说明:游戏关闭后,返回的地址(return_url=返回地址的参数),如果不填写,游戏没有返回按钮。
+
+
+## 网址
+```
+http://{BesoftFront}/?key=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701
+568BA675BDA3C46BCA64D243007F87C86119329271708&gid=be001&lang=en&return_url=https://returnyoururl.com
+
+```
+>新开界面:如果需要直接关闭当前窗口,请使用window.open方式打开,并且不需要传入return_url
+
+
+>新开界面:如果加入return_url参数,请以URLEncoding方式编码参数
+
+
+>内嵌界面:如果是内嵌请监听此消息通知(closeMessage),游戏厂商关闭游戏的调用接口
+```
+{
+   window.parent.postMessage("closeMessage", "*")
+}
+
+```
+
+
+## 请求参数
+
+| 名称     | 类型     | 必要    |     描述        | 
+| -------- | -------- | -------- |    -------- |  
+| acc     | String(30)     |   Y |     用户ID |
+| key     |string(86) |  Y |从 getKey 接口拿到的 key。若使用 HTTP GET 方法,请以 URLEncoding 编码参数|
+| aid | string(20) | Y |      代理帐号  |
+| nick | string (50) | Y |     用户名,最多支持 16 个 Unicode 字节  |
+| gid | Integer | Y |      预设登入的游戏 ID ;  |
+| lang | string | Y |      默认值为简中 (简中 英文) |
+| return_url | string | N |      return_url=游戏关闭的返回地址 ,请以URLEncoding方式编码参数|
+##  返回结果
+
+### 成功的结果
+
+>Redirect Browser to gamehall page; 导引至游戏页面
+
+### 失败的结果
+
+>游戏界面显示相应的错误信息
+
+
+
+
 ##  请求游戏入口icon地址的拼接方法
 > gameicourl+/+ gid+"_game_icon_"+尺寸+"_"+语言编码+".png"
 

+ 0 - 1
transfer/zh/keys.md

@@ -23,7 +23,6 @@
 | -------- | -------- | -------- |    -------- |  
 | cert     | string     |   Y |     安全代码 |
 | user      |string (30) |  Y |      每个网站上唯一的用户 ID(仅允许小写a-z 和 0-9)|
-| userName  |String(50) |  Y |      显示BESOFT 內游戏里的名字, 最多支持 16 个 Unicode 字节|
 | extension1 | string(20) | Y |     代理帐号(每一个代理帐号只能用于单一运营商) |
 
 

+ 18 - 0
transfer/zh/lobby.md

@@ -0,0 +1,18 @@
+# <font > 游戏大厅接入 </font>
+## 描述 
+
+> 介绍接入游戏大厅的流程
+
+
+## 步骤
+### 一、获取游戏列表页面
+
+- 调用接口url:https://hall.stag-topgame.com
+
+### 三、调用接口实例:
+- 调用接口url + 跳转参数
+> https://hall.stag-topgame.com/?tt=3F6AE577A2E2255EF4BACF02C9F8BB1154A9C6AD2F19701&lang=en
+
+参数说明:
+    参数tt:通过获取密钥接口(api/game/getKey)得到的key
+    参数lang:要显示的语言