|
@@ -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
|
|
|
+
|
|
|
|
|
|
-- 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
|
|
|
-
|
|
|
+#### 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
|
|
|
+
|