2.1.1.鉴权接口
优质
小牛编辑
141浏览
2023-12-01
修订记录
- 2017-12-27：新增校验Openid，Openkey/AccessToken有效性的CGI
- 2018-09-19：增加代码调用样例和常见问题说明
请求域名说明
测试环境
- 域名:http://openapi-test.hudong.qq.com/openapi/apollo_verify_openid_openkey
- 可以使用http协议调用，游戏创建后，不需要正式发布也可以调用
正式环境
- 域名：https://openapi.hudong.qq.com/openapi/apollo_verify_openid_openkey
- 只能使用https协议调用，并且必须在游戏上线申请通过，游戏正式发布后才可以调用
请求方式说明
- 无论测试或正式环境，都必须采用POST方法发起请求
- Content-Type头域需设置为application/x-www-form-urlencoded
- 提交数据放置于BODY，不允许放在URL
公共参数
| 参数名称 | 参数类型 | 参数中文描述 | 备注 |
|---|---|---|---|
| ts | 32位无符号整形 | 命令发起时间戳 | UNIX时间戳，放在签名中避免重放攻击 |
| rnd | 32位无符号整形 | 随机数 | 32位整形随机数，放在签名中避免碰撞 |
| sig | 字符串 | 签名 | 用于鉴权，签名算法参照签名算法章节 |
签名算法
常见问题
- 接入过程中遇到问题，请参见常见问题
校验Openid，Openkey
请求格式 appid=1&gameid=2017&ts=1111&openid=222&openkey=1111&sig=xxxxxxxx&rnd=1512981097
请求参数
| 参数名称 | 参数类型 | 参数中文描述 | 备注 |
|---|---|---|---|
| appid | 32位无符号整形 | 用户在开放平台申请的id | |
| gameid | 32位无符号整形 | 游戏ID | 分配的游戏ID |
| openkey | 字符串 | 用户openkey | 用于指定用户 |
| openid | 字符串 | 用户openid | 用于指定用户 |
- 响应格式
{"ret":0,"data":{},"msg":""}
- 响应参数：
| 参数名称 | 参数类型 | 参数中文描述 | 备注 |
|---|---|---|---|
| ret | 32位有符号整形数 | 返回码 | 0为成功，其他为失败 |
| data | JSON对象 | 返回参数内容 | JSON对象，道具详情数据 |
| msg | 字符串 | 出错时返回详情 |
公共错误码定义
| 错误码 | 错误码含义 |
|---|---|
| -100008 | 签名检查通过，但携带的OPENID、OPENKEY鉴权不过，参考常见问题 |
| -100012 | 缺少输入参数或输入参数错误 |
| -100017 | 签名检查失败，根据msg判断具体原因，参考常见问题 |
| -100050 | 系统内部异常 |