API接口清单.md 11 KB

祈盟SDK 接口清单

来源: Apipost OpenAPI 文档 (v1.0.0) 接口总数: 87 个路径


一、接口总览(按业务模块分类)

1. 公共模块

方法 路径 功能 备注
GET /v2.Captcha/getCaptcha 图形验证码 多处复用(注册、绑定、忘记密码、新设备判断)
POST /v2.CheckUpdate/version.html 安卓热更新(进入游戏时) 客户端小文件更新
POST /v2.game_notify/index_v2 游戏公告&强更&分包更新-v2 准备弃用
POST /v2.game_notify/index_v3 游戏公告&强更&分包更新-v3 替代v2
POST /v2.privacy/privacy 协议内容获取
GET http://qm_url.7dgame.cn/ 获取请求域名地址(正式)
GET http://qm_url.7dgame.cn/dev 获取请求域名地址(测试)
POST /game/getChannelOrGame 获取渠道和游戏数据(H5)

2. 注册&登录模块

方法 路径 功能 备注
POST /v1.login/index.html 账户登录
POST v1.login/checkToken.html 自动登录(Token校验)
POST /v1.login/logout.html 退出登录
POST /v1.login/third 第三方用户登录
POST /v1.register/index.html 手机号注册
POST /v1.register/createUsername.html 注册生成用户名
POST /v1.send_sms/index.html 发送短信验证码 手机注册/忘记密码/绑定手机号共用
POST /v1.is_identity/isVerified.html 是否已实名认证 登录+充值前调用
POST /v1.Is_Identity/isLoginPopup.html 是否实名认证弹窗 登录后调用
POST /v2.user/personalIdentity 实名认证
POST /v2.user/userinfo 用户详情
POST /v2.config/getconfig 第三方登录参数配置

3. 绑定手机号

方法 路径 功能 备注
POST /v2.user/getBindPhoneCode 获取验证码(绑定/换绑)
POST /v2.user/bindPhone 手机号绑定

4. 忘记密码

方法 路径 功能 备注
POST /v2.forget/resetPwdSendCode 发送验证码 流程1
POST /v2.forget/resetPwdCheckCode 效验验证码 流程2
POST /v2.forget/forgetPwdToReset 重置密码 流程3

5. 新设备判断

方法 路径 功能 备注
POST /v2.user/newImeilValid 验证验证码
POST /v2.user/getNewImeiCode 验证码获取

6. 我的(用户中心)

方法 路径 功能 备注
POST /v2.user/updatePwd 密码修改
POST /v2.user/problem 常见问题
POST /v2.user/getChannelCall 专属客服
POST /v2.AiAssistant/getConfig AI助手配置

7. 换绑手机号

方法 路径 功能 备注
POST /v2.user/unbindingPhoneCode 旧手机号-获取验证码
POST /v2.user/checkUnbindingPhoneCode 旧手机号-效验验证码
POST /v2.user/unbindingPhone 换绑-绑定新手机号

8. 订单模块

方法 路径 功能 备注
POST /v2.order/orderList 订单列表
POST /v2.order/orderInfo 订单详情
POST /v2.order/cancelOrder 取消订单 充值/支付共用

9. 充值(平台币)

方法 路径 功能 备注
POST /v2.coin/payType 支付方式列表
POST /v2.coin/pay 发起充值
POST /v2.order/getMemberCoinList 交易明细列表

10. 代金券

方法 路径 功能 备注
POST /v2.coupon/getcoupon 可领取代金券列表
POST /v2.coupon/getMyCoupon 我的代金券列表
POST /v2.coupon/exchangeCoupon 兑换代金券码
POST /v2.coupon/receiveCoupon 领取代金券

11. 礼包

方法 路径 功能 备注
POST /v2.Gift/giftList 礼包列表
POST /v2.Gift/getMyGiftList 我的礼包列表
POST /v2.Gift/giftPack 领取礼包

12. SDK 支付(游戏内购买道具)

方法 路径 功能 备注
POST /v2.order/getPayInfo 获取支付信息
POST /v1.pay/index.html 发起支付
POST /v1.pay/querypay.html 订单信息查询

13. 支付回调(SDK)

方法 路径 功能 备注
GET /v1.pay_notify/xty_pay.html 喜钛游-支付回调
POST /v1.pay_notify/qzl_pay.html 趣智连-支付回调
GET /index/notidy 支付回调示例
GET /v1.pay_notify/dianhun 电魂订单通知

14. 角色管理

方法 路径 功能 备注
POST /v1.role/index.html 角色数据上传

15. 聚合渠道

方法 路径 功能 备注
POST /v1.complex_login/getSpecialParam 1. 渠道效验(获取用户ID)
POST /v1.complex_login/index.html 2. 登录效验
POST /v1.complex_pay/index.html 3. 发起下单
POST /v2.complex_authentication/check 4. 渠道实名认证 非必请求,客户端+对接方使用
POST /v2.complex/handle.html 5. 角色上传接口
POST /v2.complex_authentication/query (弃用)实名认证结果查询

16. 聚合游戏回调-服务端(渠道支付回调)

方法 路径 渠道
POST /v1.complex_pay_notify/notify/channelqf/congyu/gameidqf/10 从语
POST /v1.complex_pay_notify/notify/channelqf/test/gameidqf/10 测试渠道
POST /v1.complex_pay_notify/notify/shenqi/gameidqf/10 神起
POST /v1.complex_pay_notify/notify/yueyou/gameidqf/10 悦游
POST /v1.complex_pay_notify/notify/sanjiu/gameidqf/10 三九互娱
POST /v1.complex_pay_notify/notify/youxiyou/gameidqf/10 游戏友
POST /v1.complex_pay_notify/notify/channelqf/weilian/gameidqf/20 唯恋
POST /v1.complex_pay_notify/notify/channelqf/jlyx/gameidqf/10 神龙游戏
GET http://sdkapi.newsdk.com/v1.complex_pay_notify/notify/channelqf/tlyx/gameidqf/10 贪乐

17. 第三方平台

方法 路径 功能 备注
POST /v2.Third/getDyCode 抖音游戏-获取access_token
POST /v2.Third/getDyAuthInfoOpen 抖音游戏-查询绑定意愿
POST /v2.Third/getJumpAuthCallback 抖音-游戏内授权后回调

18. 抖音游戏平台

方法 路径 功能
POST /v2.DyGameOpen/getAuthLogin 抖音-授权登录
POST /v2.DyGameOpen/getMobileCode 抖音-手机号发送验证码
POST /v2.DyGameOpen/getMobileCheck 抖音-手机号验证码校验
POST /v2.DyGameOpen/getRoleList 抖音-获取角色列表
POST /v2.DyGameOpen/HandleEventNotice 抖音-绑定事件通知

19. 直播平台(数据查询)

方法 路径 功能
POST /gh/get_role 获取角色数据
POST /gh/get_pay_list 获取订单列表数据
POST /gh/get_sub_user_list 获取注册归属列表数据
POST /gh/get_player_active 获取玩家活跃数据列表
POST /gh/channel_data_summary 获取渠道数据汇总(弃用)
POST /gh/channel_data_summary_v2 获取渠道数据汇总V2
POST /gh/get_sub 获取游戏账户列表

20. 服务端效验

方法 路径 功能 备注
POST /v1.helper/checkToken.html CP登录二次效验 服务端+聚合渠道

21. AI助手

方法 路径 功能
POST /v2.AiAssistant/getConfig AI助手配置

22. 其他

方法 路径 功能
POST /v2.user/getYqlChannel 获取176的渠道推广信息

二、接口流程说明

登录流程

1. 图形验证码 → /v2.Captcha/getCaptcha
2. 登录 → /v1.login/index.html
3. 实名认证检查 → /v1.is_identity/isVerified.html
4. 实名认证弹窗 → /v1.Is_Identity/isLoginPopup.html
5. 自动登录(Token刷新) → v1.login/checkToken.html

注册流程

1. 图形验证码 → /v2.Captcha/getCaptcha
2. 发送短信验证码 → /v1.send_sms/index.html
3. 手机号注册 → /v1.register/index.html
4. 生成用户名 → /v1.register/createUsername.html

忘记密码流程

1. 图形验证码 → /v2.Captcha/getCaptcha
2. 发送验证码 → /v2.forget/resetPwdSendCode
3. 效验验证码 → /v2.forget/resetPwdCheckCode
4. 重置密码 → /v2.forget/forgetPwdToReset

游戏支付流程

1. 实名认证检查 → /v1.is_identity/isVerified.html
2. 获取支付信息 → /v2.order/getPayInfo
3. 发起支付 → /v1.pay/index.html
4. 查询订单 → /v1.pay/querypay.html
5. 支付回调(渠道推送)

聚合渠道对接流程

1. 渠道效验 → /v1.complex_login/getSpecialParam
2. 登录效验 → /v1.complex_login/index.html
3. 发起下单 → /v1.complex_pay/index.html
4. 渠道实名认证(可选)→ /v2.complex_authentication/check
5. 角色上传 → /v2.complex/handle.html
6. 支付回调(渠道推送)

绑定手机号流程

1. 图形验证码 → /v2.Captcha/getCaptcha
2. 获取验证码 → /v2.user/getBindPhoneCode
3. 绑定手机号 → /v2.user/bindPhone

换绑手机号流程

1. 旧手机号获取验证码 → /v2.user/unbindingPhoneCode
2. 旧手机号效验验证码 → /v2.user/checkUnbindingPhoneCode
3. 绑定新手机号 → /v2.user/unbindingPhone

三、签名规则

1. 去掉 sign 参数
2. 按 key 升序排列
3. 拼接 key=value 并追加 appkey
4. 转换为小写(含罗马数字特殊转换)

四、公共参数

参数 说明 必填
device 设备来源(1=PC, 2=安卓, 3=苹果, 4=H5)
channel_id 渠道ID
appid 应用ID
gameid 游戏ID
imeil 设备号
version 版本号
token 登录Token

五、响应码约定

响应码 含义
100 登录失效
110 参数有误
120 处理提示
130 执行异常
200 正常

六、外部渠道回调汇总

渠道 回调路径
喜钛游 /v1.pay_notify/xty_pay.html
趣智连 /v1.pay_notify/qzl_pay.html
电魂 /v1.pay_notify/dianhun
从语 /v1.complex_pay_notify/notify/channelqf/congyu/gameidqf/10
神起 /v1.complex_pay_notify/notify/shenqi/gameidqf/10
悦游 /v1.complex_pay_notify/notify/yueyou/gameidqf/10
三九互娱 /v1.complex_pay_notify/notify/sanjiu/gameidqf/10
游戏友 /v1.complex_pay_notify/notify/youxiyou/gameidqf/10
唯恋 /v1.complex_pay_notify/notify/channelqf/weilian/gameidqf/20
神龙游戏 /v1.complex_pay_notify/notify/channelqf/jlyx/gameidqf/10
贪乐 /v1.complex_pay_notify/notify/channelqf/tlyx/gameidqf/10