页游渠道对接接口文档
文档更新记录
| 版本 | 更新日期 | 更新说明 |
|---|---|---|
| 1.0.0 | 2019.06.25 | 编写文档 |
接口要求规范
- 参数time为Unix时间戳（January 1 1970 00: 00:00 GMT 起的秒数），单位为秒
- 编码统一使用 UTF-8
- 接口请求方式为 GET 或者POST
- 将接口除了sign外的所有参数按照参数名升序排列组合成key1=value1&key2=value2···&key做md5。注:如参数值为空不参与签名
- 接口统一签名key由我方提供(请联系运营人员获取)
登录接口
- 接口说明 玩家在平台选择游戏区并登陆游戏时，平台将相关信息通过该登录接口发给游戏验证，待验证通过后将会引导玩家进入游戏界面。
- 接口地址
http://api.lianyun.ledu.com/game/start
- 接口示例
http://api.lianyun.ledu.com/game/start?game_id=$game_id&platform=$platform&server_sn=$server_sn&uid=$uid&fcm=$fcm&isclient=$isclient&time=$time&idcard=$idcard&sign=$sign
- 参数说明
| 参数名 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| game_id | int | 必须 | 游戏id，我方提供，示例:game_id=297。 |
| platform | int | 必须 | 合作商id，我方提供，示例:platform=38。 |
| server_sn | int | 必须 | 所属服务器id，1服填写1，依次类推 |
| uid | string | 必须 | 玩家在平台的用户名，用户名支持字母、数字、下划线 |
| fcm | int | 必须 | 防沉迷信息，1：成年, 0：未成年 |
| isclient | int | 必须 | 登录方式，1:微端登录，0:网页登录 |
| time | int | 必须 | 平台服务器的时间戳，超时时间2分钟 |
| idcard | string | 选填 | 身份证信息。(为空时不参与签名) |
| sign | string | 必须 | 除了sign外的所有参数按照参数名升序排列组合md5(key1=value1&key2=value2···&key)转成小写。Key由我方提供 |
- 错误值说明
| 错误提示 | 错误原因 |
|---|---|
| platform not config | 请检查game_id和platform值，必须是我方提供的值。 |
| server_not_exist | 请联系运营人员后台配置区服 |
| game_not_exist | 请联系运营人员后台配置游戏 |
| 签名错误 | 请检查签名顺序，签名参数以及签名key。(参数为空时不参与签名) |
游戏角色查询接口
- 接口说明 查询用户角色是否存在，并且返回玩家角色信息。
- 接口地址
http://api.lianyun.ledu.com/game/user
- 接口示例
http://api.lianyun.ledu.com/game/user?game_id=$game_id&platform=$platform&server_sn=$server_sn&uid=$uid&time=$time&sign=$sign
4.参数列表
| 参数名 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| game_id | int | 必须 | 游戏id，我方提供，示例:game_id=297。 |
| platform | int | 必须 | 合作商id，我方提供，示例:platform=38。 |
| server_sn | int | 必须 | 所属服务器id，1服填写1，依次类推 |
| uid | string | 必须 | 玩家在平台的用户名，用户名支持字母、数字、下划线 |
| time | int | 必须 | 平台服务器的时间戳，超时时间2分钟 |
| sign | string | 必须 | 除了sign外的所有参数按照参数名升序排列组合md5(key1=value1&key2=value2···&key)转成小写。Key由我方提供 |
返回示例
- 游戏多角色返回
{"error":1000,"data":[{"name":"\u89d2\u8272\u6635\u79f01","level":71},{"name":"\u89d2\u8272\u6635\u79f02","level":55}],"msg":"提示信息"}- 游戏单角色返回:
{"error":1000,"data":{"name":"\u89d2\u8272\u6635\u79f01","level":71},"msg":"提示信息"}返回值说明
| error | msg | 说明 |
|---|---|---|
| 1000 | 无 | 获取角色信息成功，json格式中data字段，角色信息为两维数组，返回帐号在游戏服的所有角色，返回角色信息说明:name 角色名称 level 角色等级 |
| 1001 | params_error | 参数为空或错误 |
| 1002 | platform_not_exist | 平台未接入，请联系运营人员 |
| 2001 | time_out | 时间戳过期 |
| 2002 | sign_error | 签名错误 |
| 3001 | game_not_exist | 游戏不存在，请联系运营人员 |
| 3002 | server_not_exist | 服务器不存在，请联系运营人员 |
| 4003 | user_not_exist | 游戏角色不存在 |
| 5001 | error_request | 游戏接口不存在 |
游戏充值接口
- 接口说明 通知游戏方下发游戏货币。
- 接口地址
http://api.lianyun.ledu.com/game/exchange
- 接口示例
http://api.lianyun.ledu.com/game/exchange?game_id=$game_id&platform=$platform&server_sn=$server_sn&uid=$uid&time=$time&sign=$sign
- 参数列表
| 参数名 | 参数类型 | 是否必须 | 说明 |
|---|---|---|---|
| game_id | int | 必须 | 游戏id，我方提供，示例:game_id=297。 |
| platform | int | 必须 | 合作商id，我方提供，示例:platform=38。 |
| server_sn | int | 必须 | 所属服务器id，1服填写1，依次类推 |
| uid | string | 必须 | 玩家在平台的用户名，用户名支持字母、数字、下划线 |
| order_id | string | 必须 | 渠道订单号 |
| money | int | 必须 | 充值金额，单位:元 |
| coin | int | 必须 | 充值游戏货币数量 |
| time | int | 必须 | 平台服务器的时间戳，超时时间2分钟 |
| sign | string | 必须 | 除了sign外的所有参数按照参数名升序排列组合md5(key1=value1&key2=value2···&key)转成小写。Key由我方提供 |
- 返回示例
{"error":1000,"msg":"提示信息"}
- 返回值说明
| error | msg | 说明 |
|---|---|---|
| 1000 | pay_succ | 游戏下发游戏货币成功 |
| 1001 | params_error | 参数为空或错误 |
| 1002 | platform_not_exist | 平台未接入，请联系运营人员 |
| 2001 | time_out | 时间戳过期 |
| 2002 | sign_error | 签名错误 |
| 3001 | game_not_exist | 游戏不存在，请联系运营人员 |
| 3002 | server_not_exist | 服务器不存在，请联系运营人员 |
| 3003 | plat_not_valid_ip | 平台ip限制 |
| 4001 | not_valid_ip | 游戏充值ip限制 |
| 4002 | orderid_exist | 订单号已经存在 |
| 4003 | user_not_exist | 游戏角色不存在 |