h5排行榜SDK

H5_SDK对接说明.md

-# H5 SDK 对接文档-v1.0
+# H5 SDK 对接文档-v1.0
@@ -154,6 +154,18 @@
 
         示例
 
+    3.10 [SDK 排行榜](#sec3.10)
+
+        接口说明
+
+        调用方式
+
+        请求参数
+
+        返回参数
+
+        示例
+
 ## 1. 接入说明<a name="sec1"></a>
 
 ### 1.1 术语表<a name="sec1.1"></a>
@@ -876,3 +888,51 @@ sdk.getLocalStorage({
 
 //
 ```
+
+### 3.10 SDK 排行榜<a name="sec3.10"></a>
+
+---
+
+##### 接口说明
+
+> 用户在点击排行榜按钮(或链接) 将角色信息和服务器信息通过参数传入sdk
+
+##### 调用方式
+
+```javascript
+zwsdk.toRankPage(config:Object)
+```
+
+##### 请求参数
+
+> | 参数                                                          | 必选  | 类型   | 默认值   | 说明                                                                                                 |
+> | :------------------------------------------------------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
+> | role                                                          | true  | Object | -        | 角色相关                                                                                             |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_id     | true  | String | ""       | 游戏服务器 ID                                                                                        |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server_name   | true  | String | ""       | 游戏服务器名称                                                                                       |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_role_id    | true  | String | ""       | 玩家角色 ID                                                                                          |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_name     | true  | String | ""       | 玩家角色名称                                                                                         |
+
+
+
+##### 返回参数
+
+> | 参数                                                                                                     | 类型   | 说明                 |
+> | :------------------------------------------------------------------------------------------------------- | :----- | :------------------ |
+> | status_code                                                                                              | String | 返回状态             |
+> | msg                                                                                                      | String | -                   |
+> | data                                                                                                     | Object | -                   |
+> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;url                                                      | String | url                 |
+
+##### 示例
+
+```javascript
+sdk.toRankPage({
+  role: {
+    server_id: '100001',
+    server_name: '主宰服',
+    cp_role_id: 'cp_role_id',
+    role_name: '哇哦是龙儿',
+  }
+})
+```
\ No newline at end of file