提交 1b62233b 作者: yyc

服务端接口文档

# Android SDK 对接文档-v1.0 # Android SDK 对接文档-v1.0
...@@ -8,9 +8,9 @@ ...@@ -8,9 +8,9 @@
    1.2 [数据字典](#sec1.2)     1.2 [数据字典](#sec1.2)
    1.4 [主动登录](#sec1.4)     1.3 [SDK登录](#sec1.3)
    1.5[下单逻辑](#sec1.5)     1.4[下单逻辑](#sec1.4)
2.[Android SDK 接入](#sec2) 2.[Android SDK 接入](#sec2)
...@@ -27,17 +27,16 @@ ...@@ -27,17 +27,16 @@
    2.2 [Android SDK 初始化](#sec2.2)     2.2 [Android SDK 初始化](#sec2.2)
        说明         配置游戏game_id
        调用方式
        示例
    2.3 [登录](#sec2.3)     2.3 [登录](#sec2.3)
        说明         说明
        链接参数         登录
        退出登录
        示例         示例
...@@ -81,8 +80,6 @@ ...@@ -81,8 +80,6 @@
> | 游戏服务 | 游戏研发商开发,为游戏提供服务。 | > | 游戏服务 | 游戏研发商开发,为游戏提供服务。 |
> | 游戏客户端 | 游戏研发方商开发的网页版游戏。 | > | 游戏客户端 | 游戏研发方商开发的网页版游戏。 |
> | 支付服务 | 由平台方调用支付服务,Google等 | > | 支付服务 | 由平台方调用支付服务,Google等 |
> | 游戏盒子 | 由平台方开发的游戏总入口,可以实现游戏登陆,支付,切换等;Android 游戏以 iframe 的形式在游戏盒子中运行。 |
> | Android 游戏入口 | 由 CP 方提供,进入 Android 游戏的入口链接。 |
### 1.2 数据字典<a name="sec1.2"></a> ### 1.2 数据字典<a name="sec1.2"></a>
...@@ -92,6 +89,7 @@ ...@@ -92,6 +89,7 @@
> | user_token | 用户在平台登录的会话标识。 | > | user_token | 用户在平台登录的会话标识。 |
> | game_id | 游戏在平台的子级唯一标识。 | > | game_id | 游戏在平台的子级唯一标识。 |
> | main_game_id | 游戏在平台的父级唯一标识。 | > | main_game_id | 游戏在平台的父级唯一标识。 |
> | fm_app_key | 广告APPKEY(平台在出对接参数时提供) |
> | game_secret | 平台方提供,游戏签名秘钥。 | > | game_secret | 平台方提供,游戏签名秘钥。 |
> | cp_order_id | 游戏研发商订单唯一标识 | > | cp_order_id | 游戏研发商订单唯一标识 |
> | order_id | 平台方订单唯一标识,与 cp_order_id 一一对应 | > | order_id | 平台方订单唯一标识,与 cp_order_id 一一对应 |
...@@ -145,6 +143,7 @@ sequenceDiagram ...@@ -145,6 +143,7 @@ sequenceDiagram
> | ----------- | ---------------------------------- | > | ----------- | ---------------------------------- |
> | game_id | 游戏唯一标识,由平台方提供 | > | game_id | 游戏唯一标识,由平台方提供 |
> | main_game_id | 主游戏唯一标识,由平台方提供 | > | main_game_id | 主游戏唯一标识,由平台方提供 |
> | fm_app_key | 广告参数(平台提供) |
##### 导入示例 ##### 导入示例
...@@ -187,16 +186,21 @@ implementation 'com.zwwl.legend.sdk:legend:1.0.0' ...@@ -187,16 +186,21 @@ implementation 'com.zwwl.legend.sdk:legend:1.0.0'
<meta-data <meta-data
android:name="game_id" android:name="game_id"
android:value="1"/> android:value="必须"/>
//主游戏ID
<meta-data <meta-data
android:name="main_game_id" android:name="main_game_id"
android:value="1"/> android:value="必须"/>
<meta-data
android:name="fm_app_key"
android:value="必填"/>
``` ```
### 2.3 调用登录方法<a name="sec2.3"></a> ### 2.3 登录<a name="sec2.3"></a>
``` ```
GameService.getInstance().showLogin(object : OnLoginListener<Any?> { GameService.getInstance().showLogin(object : OnLoginListener<Any?> {
...@@ -207,7 +211,7 @@ implementation 'com.zwwl.legend.sdk:legend:1.0.0' ...@@ -207,7 +211,7 @@ implementation 'com.zwwl.legend.sdk:legend:1.0.0'
}) })
``` ```
### 退出登录方法 ### 退出
``` ```
GameService.getInstance().loginOut(object:InitZyCallback{ GameService.getInstance().loginOut(object:InitZyCallback{
...@@ -268,6 +272,42 @@ private fun googlePlay(){ ...@@ -268,6 +272,42 @@ private fun googlePlay(){
} }
``` ```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :------------------------------------------------------------ | :---- | :----- | :------- | :--------------------------------------------------------------------------------------------------- |
> | order | true | Object | - | 订单相关 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_order_id | true | String | - | 游戏传入的外部订单号,服务器会根据这个订单号生成对应的平台订单号,请保证每笔订单传入的订单号的唯一性 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_price | true | String | - | 商品价格(单价,单位:分) |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_id | true | String | - | 商品 ID |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;amount | true | String | - | 商品总价(单位:分) |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_cnt | true | String | - | 商品数量 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_name | true | String | - | 商品名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product_desc | true | String | - | 商品描述 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ext | false | String | "" | CP 自定义扩展字段,透传信息 |
> | role | true | Object | - | 角色相关 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;event | true | String | recharge | 充值上传的角色信息 |
> | &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 | "" | 玩家角色名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_level | true | String | "0" | 玩家角色等级 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_vip | true | String | "0" | 玩家 VIP 等级 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;combat_num | false | Int | 0 | 角色战力 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;online_time | false | Int | 0 | 本次在线时长 |
##### 返回参数
> | 参数 | 类型 | 说明 |
> | :------------------------------------------------------------------------------------------------------- | :----- | :------------------------- |
> | status_code | String | 返回状态 |
> | msg | String | 返回信息 |
> | data | Object | 用户数据 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;data | Object | 用户数据 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;order_id | String | 订单 ID,可用于订单状态查询 |
### 2.5角色上报(角色上报参数字段请参考文档字段说明)<a name="sec2.5"></a> ### 2.5角色上报(角色上报参数字段请参考文档字段说明)<a name="sec2.5"></a>
``` ```
...@@ -309,25 +349,45 @@ private fun googlePlay(){ ...@@ -309,25 +349,45 @@ private fun googlePlay(){
``` ```
##### 请求参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | :---------------------------------------------------------- | :---- | :----- | :----- | :---------------------- |
> | role | true | Object | - | 角色信息 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;event | true | String | other | 事件类型 |
> | &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 | - | 游戏角色名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_level | true | Int | - | 角色等级 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;cp_account | false | String | - | cp 账号 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;role_vip | false | Int | 0 | 角色 VIP 等级(赞助等级) |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;combat_num | false | Int | 0 | 角色战力 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;reiki_num | false | Int | 0 | 角色灵符值 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;online_time | false | Int | 0 | 本次在线时长 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attack | false | Int | 0 | 攻击力 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;profession | false | String | - | 职业 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;gang_name | false | String | - | 帮会(行会)名称 |
> | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;trans_level | false | Int | 0 | 转生等级 |
##### 返回参数
> | 参数 | 必选 | 类型 | 默认值 | 说明 |
> | ----------- | ---- | ------ | ------ | -------- |
> | status_code | true | Int | - | 状态码 |
> | msg | true | STRING | - | 返回信息 |
| 名称 | 类型 | 是否必须 | 默认值|说明 | ##### EVENT 枚举
|:--------------|-------:|-----:|-----:|-----------------:|
| cp_order_id | string | 必须 || CP订单ID | > | EVENT | 说明 |
| amount | number | 必须 | |商品总价(单位:分 | > | -------- | -------- |
| product_price | number | 必须 | |商品价格(整数,后台自动换算分) | > | create | 创建角色 |
| product_id | String | 必须 |0| 商品ID | > | online | 角色上线 |
| product_cnt | number | 必须 | |商品数量 | > | offline | 角色下线 |
| product_name | string | 必须 |""| 商品名称 | > | level_up | 角色升级 |
| product_desc | string | 非必须 |""| 商品描述 | > | delete | 删除角色 |
| ext | string | 必须 |""| 订 调用方定义 单额外信息用(json)| > | recharge | 角色充值 |
| event | string | 必须 |""| 事件| > | other | 其他 |
| server_id | string | 必须 |0| 区服id |
| server_name | string | 必须 |""| 区服名称|
| cp_role_id | string | 必须 | cp角色id |
| role_name | string | 必须 | ""|角色名称 |
| role_level | string | 必须 |0| 角色等级 |
| role_vip | string | 必须 | 0|角色vip等级 |
| role_id | string | 必须 |0| 角色ID |
......
## ZYouSDK V1.0.0文档接入使用 ## ZYouSDK V1.0.0文档接入使用
...@@ -24,19 +24,17 @@ ...@@ -24,19 +24,17 @@
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[下单支付字段说明](#sec6.2) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[下单支付字段说明](#sec6.2)
&nbsp;&nbsp;&nbsp;&nbsp;7 [支付回调通知](#sec7) &nbsp;&nbsp;&nbsp;&nbsp;7 [角色上报](#sec8)
&nbsp;&nbsp;&nbsp;&nbsp;8 [角色上报](#sec8)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [参数说明](#sec8.1) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [参数说明](#sec8.1)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[调用示例](#sec8.2) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[调用示例](#sec8.2)
&nbsp;&nbsp;&nbsp;&nbsp;9 [退出登录](#sec9) &nbsp;&nbsp;&nbsp;&nbsp;8 [退出登录](#sec9)
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[调用示例](#sec9.1) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[调用示例](#sec9.1)
&nbsp;&nbsp;&nbsp;&nbsp;10 [服务端登录验证接口](#sec10) &nbsp;&nbsp;&nbsp;&nbsp;9 [服务端登录验证接口](#sec10)
#### 1、对接说明 <a name="sec1"></a> #### 1、对接说明 <a name="sec1"></a>
&nbsp;&nbsp; 1.1、此sdk只支持iOS9.0以上版本 &nbsp;&nbsp; 1.1、此sdk只支持iOS9.0以上版本
&nbsp;&nbsp; 1.2、此sdk支持横竖屏 &nbsp;&nbsp; 1.2、此sdk支持横竖屏
...@@ -50,7 +48,8 @@ ...@@ -50,7 +48,8 @@
| 参数名 | 说明 | | 参数名 | 说明 |
|:--------| -------------:| |:--------| -------------:|
| game_id | 游戏唯一标识,由平台方提供 | | game_id | 游戏唯一标识,由平台方提供 |
|game_secret|服务端对接时会用到,由平台方提供| | main_game_id | 主游戏id,由平台方提供 |
|game_secret|游戏签名密钥,服务端对接时会用到,由平台方提供|
> **内购说明**: > **内购说明**:
支持内购cp方需要提供内购的商品列表 支持内购cp方需要提供内购的商品列表
...@@ -177,7 +176,7 @@ app启动时调用注册sdk 在AppDelegate文件中#import "ZYouTool.h" ...@@ -177,7 +176,7 @@ app启动时调用注册sdk 在AppDelegate文件中#import "ZYouTool.h"
``` ```
### 6、调起支付页面<a name="sec6"></a> ### 6、支付下单<a name="sec6"></a>
调起支付页面方法<a name="sec7.1"></a> 调起支付页面方法<a name="sec7.1"></a>
...@@ -251,11 +250,7 @@ app启动时调用注册sdk 在AppDelegate文件中#import "ZYouTool.h" ...@@ -251,11 +250,7 @@ app启动时调用注册sdk 在AppDelegate文件中#import "ZYouTool.h"
| role_id | string | 必须 |0| 角色ID | | role_id | string | 必须 |0| 角色ID |
### 7、支付回调通知<a name="sec7"></a> ### 7、角色上报<a name="sec8"></a>
1.1
1.1、支付回调通知请参考对接文档H5 SDK 对接文档-v1.0、服务端接入
### 8、角色上报<a name="sec8"></a>
角色上报方法 角色上报方法
``` ```
//角色上报 //角色上报
...@@ -336,7 +331,7 @@ app启动时调用注册sdk 在AppDelegate文件中#import "ZYouTool.h" ...@@ -336,7 +331,7 @@ app启动时调用注册sdk 在AppDelegate文件中#import "ZYouTool.h"
| recharge | 角色充值 | | recharge | 角色充值 |
| other | 其他 | | other | 其他 |
### 9、退出登录<a name="sec9"></a> ### 8、退出登录<a name="sec9"></a>
``` ```
//退出登录 //退出登录
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论