Browse Source

领取兑换码文档

Jason 5 days ago
parent
commit
c7a1c69099
8 changed files with 110 additions and 2 deletions
  1. 1 0
      en/_sidebar.md
  2. 1 0
      en/api_interface.md
  3. 1 1
      en/get_user_info.md
  4. 52 0
      en/redeemcode_use.md
  5. 1 0
      zh/API_interface.md
  6. 1 0
      zh/_sidebar.md
  7. 1 1
      zh/get_user_info.md
  8. 52 0
      zh/redeemcode_use.md

+ 1 - 0
en/_sidebar.md

@@ -19,6 +19,7 @@
   * [Query Total Win All Players](en/all_user_win_result)
   * [Change Password](en/change_password)
   * [Redeem Code](en/redeemcode_create)
+  * [Claim Redeem Code](en/redeemcode_use)
 * [Appendix](en/appendix)
   * [Currency List](en/currency)
   * [Languages](en/language)

+ 1 - 0
en/api_interface.md

@@ -20,6 +20,7 @@
             <li><a href="#en/recycle_bonus_code">Recycle Bonus Code</a></li>
             <li><a href="#en/modify_password">Change Password</a></li>
             <li><a href="#en/redeemcode_create">Redeem Code</a></li>
+            <li><a href="#en/redeemcode_use">Claim Redeem Code</a></li>
         </font>
     </ul>
 </body>

+ 1 - 1
en/get_user_info.md

@@ -40,7 +40,7 @@
 | regtime       | string | 32     | Registration time                                     |
 | ingot         | double | 19     | Bonus code / ingot amount                             |
 | score         | double | 19     | Player score                                          |
-| wallet      | int    | 32     | wallet type: 0=normla,2=free                          |
+| wallet        | int    | 32     | wallet type: 0=normla,2=free                          |
 | onlinestatus  | int    | 4      | Player status: 0 = Offline, 1 = In Lobby, 2 = In Game |
 | memo          | string | 128    | Notes                                                 |
 | state         | int    | 4      | Account status: 0 = Active, -1 = Banned               |

+ 52 - 0
en/redeemcode_use.md

@@ -0,0 +1,52 @@
+# <font>Claim Redeem Code</font>
+
+## Request URL
+>{API_URL}
+
+## Request Parameters
+
+| Field Name | Type   | Length | Description |                                            |
+| ---------- | ------ | ------ | ----------- | ------------------------------------------ |
+| itype      | string | 21     | Yes          | 31 = Claim Redeem Code                     |
+| authcode   | string | 32     | Yes          | gent identifier, assigned by the provider  |
+| authkey    | string | 32     | Yes          | Agent secret key, assigned by the provider |
+| useracc    | string | 128    | Yes          | user account                               |
+| redeemcode | string | 16     | Yes          | redeem code                                |
+
+
+
+## Example
+
+- **URL**:
+    - {API_URL}
+
+- **HTTP Method**:
+    - `POST`
+
+- **Form Data**:  
+    > Content-Type: `application/x-www-form-urlencoded`
+
+    ```
+    itype           :31
+    authcode        :test666
+    authkey         :KepYRwz4mOP3THAcfiQb
+    useracc         :67595454852
+    redeemcode      :07UTEL
+
+    ```
+
+## Response Fields
+
+| Field Name | Type | Length | Description                                           |
+| -------- | ------ | ---- | ------------------------ |
+| ret        | int  | 32     | -1 indicates success; other than -1 indicates failure |
+
+
+## Response Format
+
+```
+{
+	"ret": -1,
+    "info": "ok"	
+}
+```

+ 1 - 0
zh/API_interface.md

@@ -20,6 +20,7 @@
             <li><a href="#zh/recycle_bonus_code">回收奖金码</a></li>
             <li><a href="#zh/modify_password">修改密码</a></li>
             <li><a href="#zh/redeemcode_create">生成兑换码</a></li>
+            <li><a href="#zh/redeemcode_use">领取兑换码</a></li>
         </font>
     </ul>
 </body>

+ 1 - 0
zh/_sidebar.md

@@ -19,6 +19,7 @@
   * [查询所有玩家总赢回](zh/all_user_win_result)
   * [修改密码](zh/change_password)
   * [生成兑换码](zh/redeemcode_create)
+  * [领取兑换码](zh/redeemcode_use)
 * [附录](zh/appendix)
   * [货币列表](zh/currency)
   * [语言](zh/language)

+ 1 - 1
zh/get_user_info.md

@@ -40,7 +40,7 @@
 | regtime       | string | 32   | 注册时间                                        |
 | ingot         | double | 19   | 奖励码                                          |
 | score         | double | 19   | 用户分数                                        |
-| wallet      | int    | 32   | 钱包类型:0=普通,2=免费                             |
+| wallet        | int    | 32   | 钱包类型:0=普通,2=免费                             |
 | onlinestatus  | int    | 4    | 用户状态: 0 = 离线, 1 = 在大厅, 2 = 在游戏中 |
 | memo          | string | 128  | 备注                                            |
 | state         | int    | 4    | 账号状态: 0 = 没封号, -1 = 封号               |

+ 52 - 0
zh/redeemcode_use.md

@@ -0,0 +1,52 @@
+# <font>领取兑换码</font>
+
+## 请求地址
+>{API_URL}
+
+## 请求参数
+
+| 字段名称   | 类型   | 长度 | 必要 | 描述                 |
+| ---------- | ------ | ---- | ---- | -------------------- |
+| itype      | string | 21   | 是   | 31 = 领取兑换码      |
+| authcode   | string | 32   | 是   | 代理标识,由厂商配发 |
+| authkey    | string | 32   | 是   | 代理秘钥,由厂商配发 |
+| useracc    | string | 128  | 是   | 玩家账号             |
+| redeemcode | string | 16   | 是   | 兑换码               |
+
+
+
+## 示例
+
+- **URL**:
+    - {API_URL}
+
+- **HTTP Method**(请求方式):
+    - `POST`
+
+- **表单数据**:
+    > Content-Type: `application/x-www-form-urlencoded`
+
+    ```
+    itype           :31
+    authcode        :test666
+    authkey         :KepYRwz4mOP3THAcfiQb
+    useracc         :67595454852
+    redeemcode      :07UTEL
+
+    ```
+
+## 返回结果
+
+| 字段名称 | 类型   | 长度 | 说明                     |
+| -------- | ------ | ---- | ------------------------ |
+| ret      | int    | 32   | -1 表示成功,非 -1 表示失败 |
+
+
+## 返回格式
+
+```
+{
+	"ret": -1,
+    "info": "ok"	
+}
+```