Showing
1 changed file
with
231 additions
and
0 deletions
haibao_h5_sdk_dock.md
0 → 100644
| 1 | +海豹平台H5游戏SDK接口说明 | ||
| 2 | + | ||
| 3 | + | ||
| 4 | + | ||
| 5 | +1. 调用方法 | ||
| 6 | + | ||
| 7 | + | ||
| 8 | + | ||
| 9 | +在调用我们的SDK前,先在页面引入js: | ||
| 10 | + | ||
| 11 | +http://bg.public.sdk.gzyouai.com:33080/static/tg/h5/js/PublicSDK.js | ||
| 12 | + | ||
| 13 | + 如果需要支持SSL,请使用:https://bg.public.sdk.gzyouai.com:33080/static/tg/h5/js/PublicSDK.js | ||
| 14 | + | ||
| 15 | +#### | ||
| 16 | + | ||
| 17 | +#### 接口调用DEMO参考: | ||
| 18 | + | ||
| 19 | +#### http://bg.public.sdk.gzyouai.com:33080/static/tg/h5/game_demo.html | ||
| 20 | + | ||
| 21 | +\2. 接口列表 | ||
| 22 | + | ||
| 23 | +2.1 用户登录/注册接口 | ||
| 24 | + | ||
| 25 | + | ||
| 26 | + | ||
| 27 | +**接口说明**: 用于调用9187平台用户登录/注册窗口,用户完成登录或者注册后,在回调中告知游戏相关的帐号信息。 | ||
| 28 | + | ||
| 29 | + | ||
| 30 | + | ||
| 31 | +**接口调用:**PUSDK.login(callback) | ||
| 32 | + | ||
| 33 | + | ||
| 34 | + | ||
| 35 | +**参数说明: | ||
| 36 | + | ||
| 37 | +| **参数** | **说明**** ** | **是否**必须** ** | **例子**** ** | | ||
| 38 | +| -------- | ----------- | ------------- | -------------------------- | | ||
| 39 | +| callback | 回调函数 | 是 | function(status, data){ } | | ||
| 40 | + | ||
| 41 | + | ||
| 42 | + | ||
| 43 | +callback**说明:** | ||
| 44 | + | ||
| 45 | +``` | ||
| 46 | + | ||
| 47 | +``` | ||
| 48 | + | ||
| 49 | +| **参数** | **说明** | **例子** | | ||
| 50 | +| ------ | ------ | ---------------------------------------- | | ||
| 51 | +| status | 状态 | 0 - 登录/注册成功 1 - 登录/注册失败 | | ||
| 52 | +| data | 帐号信息 | 当status=0时同时返回一个js对象 data={ userType:用户类型 openId:用户ID timestamp:时间戳 token:用户的token } 请使用**open**作为我方用户的唯一ID,account仅作为显示使用。 serverSign用来做二次校验用,由**研发服务器**向我方服务器发起,通过serverSign校验后,玩家登录才算成功,校验接口详见下方 | | ||
| 53 | + | ||
| 54 | + | ||
| 55 | + | ||
| 56 | + | ||
| 57 | + | ||
| 58 | +token校验接口服务端文档:[http://gitlab.9133.com:10080/public_service/public_sdk_android/blob/master/publicAndroidSDK/doc/%E5%85%AC%E5%85%B1SDK%E6%9C%8D%E5%8A%A1%E7%AB%AF%E6%8E%A5%E5%85%A5%E6%96%87%E6%A1%A3.md](http://118.123.216.79:20013/10?page_id=59) | ||
| 59 | + | ||
| 60 | + | ||
| 61 | + | ||
| 62 | +**返回值:**无**** | ||
| 63 | + | ||
| 64 | + | ||
| 65 | + | ||
| 66 | +2.3 支付接口 | ||
| 67 | + | ||
| 68 | + | ||
| 69 | + | ||
| 70 | +**接口说明**: 用于调用海豹平台用户支付窗口,在调用本接口前,游戏先完成自己的下单,然后将相应的支付信息通知我们的SDK,用户完成支付后,我们会在前端返回支付结果,同时我们的服务器端也会通知游戏方的服务端,进行发货请求,请务必以服务端调用为准。 | ||
| 71 | + | ||
| 72 | + | ||
| 73 | + | ||
| 74 | +**接口调用:**PUSDK.pay(payInfo,callback) | ||
| 75 | + | ||
| 76 | + | ||
| 77 | + | ||
| 78 | +**参数说明:** | ||
| 79 | + | ||
| 80 | +** ** | ||
| 81 | + | ||
| 82 | +| **参数** | **说明**** ** | **是否**必须** ** | **例子**** ** | | ||
| 83 | +| -------- | ----------- | ------------- | -------------------------- | | ||
| 84 | +| payInfo | 支付信息(JS对象) | 是 | 支付数据见下表 | | ||
| 85 | +| callback | 回调函数 | 是 | function(status, data){ } | | ||
| 86 | + | ||
| 87 | +** ** | ||
| 88 | + | ||
| 89 | +``` | ||
| 90 | + | ||
| 91 | +``` | ||
| 92 | + | ||
| 93 | +** ** | ||
| 94 | + | ||
| 95 | +**payInfo说明:** | ||
| 96 | + | ||
| 97 | +``` | ||
| 98 | + | ||
| 99 | +``` | ||
| 100 | + | ||
| 101 | +| **字段** | **说明**** ** | **是否必须** | | ||
| 102 | +| ----------- | ----------------------- | -------- | | ||
| 103 | +| | | | | ||
| 104 | +| productid | 商品ID | 是 | | ||
| 105 | +| productname | 商品名称 | 是 | | ||
| 106 | +| productdesc | 商品描述 | 是 | | ||
| 107 | +| exchange | 兑换率 1元= 10金币 这里就填10 | 是 | | ||
| 108 | +| serverid | 服务器ID | 是 | | ||
| 109 | +| servername | 服务器名称 | 是 | | ||
| 110 | +| roleid | 角色ID | 是 | | ||
| 111 | +| rolename | 角色名称 | 是 | | ||
| 112 | +| rolelevel | 角色等级 | 是 | | ||
| 113 | +| amount | 金额 | 是 | | ||
| 114 | +| custom | 扩展数据,如果设置,在发货接口会原样返回该数据 | 可选 | | ||
| 115 | + | ||
| 116 | + | ||
| 117 | + | ||
| 118 | + | ||
| 119 | + | ||
| 120 | +**callback说明:**客户端没有支付返回通知,以服务器支付返回通知为准 | ||
| 121 | + | ||
| 122 | + | ||
| 123 | + | ||
| 124 | + | ||
| 125 | + | ||
| 126 | +**返回值:**无**** | ||
| 127 | + | ||
| 128 | + | ||
| 129 | + | ||
| 130 | +2.4 角色创建日志上报接口 | ||
| 131 | + | ||
| 132 | + | ||
| 133 | + | ||
| 134 | +**接口说明**:本接口用于角色创建日志上报。 | ||
| 135 | + | ||
| 136 | + | ||
| 137 | + | ||
| 138 | +接口调用:PUSDK.logCreateRole(serverId,serverName, roleId, roleName, roleLevel, roleCreateTime) | ||
| 139 | + | ||
| 140 | + | ||
| 141 | + | ||
| 142 | +**参数说明:** | ||
| 143 | + | ||
| 144 | +| **参数** | **说明**** ** | **是否**必须** ** | **例子**** ** | | ||
| 145 | +| -------------- | ----------- | ------------- | ----------- | | ||
| 146 | +| serverId | 服务器ID | 是 | | | ||
| 147 | +| serverName | 服务器名称 | 是 | | | ||
| 148 | +| roleId | 角色ID | 是 | | | ||
| 149 | +| roleName | 角色名 | 是 | | | ||
| 150 | +| roleLevel | 角色等级 | 是 | 固定为0 | | ||
| 151 | +| roleCreateTime | 创角的Unix时间戳 | 否 | 默认为当前时间 | | ||
| 152 | + | ||
| 153 | +** ** | ||
| 154 | + | ||
| 155 | +``` | ||
| 156 | + | ||
| 157 | +``` | ||
| 158 | + | ||
| 159 | +** ** | ||
| 160 | + | ||
| 161 | +**返回值:**无**** | ||
| 162 | + | ||
| 163 | + | ||
| 164 | + | ||
| 165 | +2.5 进入游戏日志上报接口 | ||
| 166 | + | ||
| 167 | + | ||
| 168 | + | ||
| 169 | +**接口说明**:本接口用于进入游戏日志上报。 | ||
| 170 | + | ||
| 171 | + | ||
| 172 | + | ||
| 173 | +**接口调用:**PUSDK.logEnterGame(serverId,serverName, roleId, roleName, roleLevel, roleCreateTime) | ||
| 174 | + | ||
| 175 | + | ||
| 176 | + | ||
| 177 | +**参数说明:** | ||
| 178 | + | ||
| 179 | +| **参数** | **说明**** ** | **是否**必须** ** | **例子**** ** | | ||
| 180 | +| -------------- | ----------- | ------------- | ----------- | | ||
| 181 | +| serverId | 服务器ID | 是 | | | ||
| 182 | +| serverName | 服务器名称 | 是 | | | ||
| 183 | +| roleId | 角色ID | 是 | | | ||
| 184 | +| roleName | 角色名 | 是 | | | ||
| 185 | +| roleLevel | 角色等级 | 是 | | | ||
| 186 | +| roleCreateTime | 创角的Unix时间戳 | 否 | 默认为当前时间 | | ||
| 187 | + | ||
| 188 | +** ** | ||
| 189 | + | ||
| 190 | +``` | ||
| 191 | + | ||
| 192 | +``` | ||
| 193 | + | ||
| 194 | +** ** | ||
| 195 | + | ||
| 196 | +**返回值:**无**** | ||
| 197 | + | ||
| 198 | +** ** | ||
| 199 | + | ||
| 200 | +2.6 进入角色升级上报接口 | ||
| 201 | + | ||
| 202 | + | ||
| 203 | + | ||
| 204 | +**接口说明**:本接口用于角色升级日志上报。 | ||
| 205 | + | ||
| 206 | + | ||
| 207 | + | ||
| 208 | +**接口调用:**PUSDK.logRoleUpLevel(serverId,serverName, roleId, roleName, roleLevel, roleCreateTime) | ||
| 209 | + | ||
| 210 | + | ||
| 211 | + | ||
| 212 | +**参数说明:** | ||
| 213 | + | ||
| 214 | +| **参数** | **说明**** ** | **是否**必须** ** | **例子**** ** | | ||
| 215 | +| -------------- | ----------- | ------------- | ----------- | | ||
| 216 | +| serverId | 服务器ID | 是 | | | ||
| 217 | +| serverName | 服务器名称 | 是 | | | ||
| 218 | +| roleId | 角色ID | 是 | | | ||
| 219 | +| roleName | 角色名 | 是 | | | ||
| 220 | +| roleLevel | 角色等级 | 是 | | | ||
| 221 | +| roleCreateTime | 创角的Unix时间戳 | 否 | 默认为当前时间 | | ||
| 222 | + | ||
| 223 | +** ** | ||
| 224 | + | ||
| 225 | +``` | ||
| 226 | + | ||
| 227 | +``` | ||
| 228 | + | ||
| 229 | +** ** | ||
| 230 | + | ||
| 231 | +**返回值:**无 | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
-
Please register or login to post a comment