# 用户价值
# 1. 全局约定
用户价值相关接口为服务端接口,开发者必须通过服务端访问,不得通过客户端访问。
# 1.1 基础定义
- app_id: 快手海外小游戏开放平台给开发者分配的 app 标识,如未获得请联系运营注册快手开发者帐号,注册后可从 快手海外小游戏开放平台 查看
- app_secret: 快手海外小游戏开放平台分配给游戏的秘钥,用于加密数据及校验权限,如未获得请联系运营注册快手开发者帐号,注册后可从 快手海外小游戏开放平台 查看。注: app_secret 请妥善保管,不要泄露。
- access_token: 快手海外小游戏开放平台 server 端 api 调用凭证
# 1.2 服务域名
https://game.kwai.com
# 1.3 请求参数说明
- 对于 GET 请求,请求参数应以 QueryString 的形式写在 URL 中。
- 对于 POST 请求,部分参数需以 QueryString 的形式写在 URL 中(一般只有access_token,如有额外参数会在文档里的 URL 中体现),其它参数如无特殊说明均以 JSON 字符串格式写在 POST 请求的 body 中。
# 1.4 请求参数校验
用户价值相关接口的校验包括OAuth2和参数验签。
为通过OAuth2验证,需在请求的URL末尾加上
access_token=获取到的access_token
。 access_token 可以通过 获取access_token 接口获取(不参与签名),有效期一般为 1 小时。在access_token有效期内访问 获取access_token 接口将返回原access_token,不会更新access_token。
access_token失效后,使用access_token访问受保护接口会返回401错误(详见 获取access_token 接口的“访问受保护资源”小节),此时应调用获取access_token接口获取新的access_token。
参数签名规则见 签名规则 ,各接口参与签名的参数标记于各接口说明中。
# 2.用户价值相关接口说明
本节所述所有请求都需要将 access_token 以参数名 access_token 拼接到 query url 参数中,以下不再赘述。
# 2.1. 用户价值等级查询
# 请求:
- GET /rest/o/game/kcoin/reward/user/level
- 请求参数:
名称 | 类型 | 取值说明 | 是否参与签名 |
---|---|---|---|
app_id | string | 从快手海外小游戏开放平台获取的 app_id | 是 |
open_id | string | 游戏服务器通过 code2Session 接口换的用户唯一标识 | 是 |
ts | long | 时间戳,单位:毫秒 | 是 |
sign | 签名 | 参数签名规则见 签名规则 | 否 |
# 响应
- Content-Type: application/json
- Body内容:
名称 | 类型 | 取值说明 |
---|---|---|
result | int | 成功 1,其他值见错误码定义 |
data | json | 响应数据data结构 |
- data内容:
名称 | 类型 | 取值说明 |
---|---|---|
user_level | int | 用户的价值等级。1:高价值,2:中价值,3:低价值 |
响应举例
{
"result": 1,
"message": "SUCCESS",
"data": {
"user_level": 0
}
}
# 3. 错误码定义
# 3.1 access_token相关错误码
access_token校验失败,响应的Http Status为401。详见 access_token接口 “访问受保护资源”小节。
# 3.2 业务相关错误码
Http Status 200
result | msg | 错误码说明 |
---|---|---|
100000 | 系统繁忙,请稍后重试 | 系统繁忙 |
100001 | 无效参数,请查看接口文档 | 传入参数无效,请查看接口文档 |
100003 | 无效请求,请确认后重试 | app_id无效 |
100006 | 无效请求,请确认后重试 | open_id无效,请确认游戏账号是否有效 |
100020 | 缺少签名参数 | 缺少签名参数 |
100021 | 签名信息已失效,请重新签名 | 签名信息已失效,请重新签名 |
100022 | 签名错误 | 签名校验未通过 |