接口路径(新):http://hn216.api.yesapi.cn/api/App/Market_KamiNum/Generate
接口路径(旧):http://hn216.api.yesapi.cn/?s=App.Market_KamiNum.Generate
接口描述: 生成单个或多个数量卡密。注意,当卡密生成过多时,有可能批量生成的数量不足于指定的数量,建议卡密长度设置长一点,避免碰撞。当不足时,再次请求接口进行生成。使用前请先安装卡密插件
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
num | 整型 | 可选 | 1 | 最小:1;最大:1000 | 需要生成的卡密数量 |
kami_num | 整型 | 必须 | 最小:1 | 奖励数量 | |
kami_type | 字符串 | 必须 | 最大:64 | 卡密类型 | |
kami_desc | 字符串 | 必须 | 卡密说明,支持富文本 | ||
kami_note | 字符串 | 可选 | 卡密备注 | ||
kami_min_len | 整型 | 可选 | 6 | 最小:6 | 卡密的最小字符长度 |
kami_max_len | 整型 | 可选 | 6 | 最小:6;最大:100 | 卡密的最大字符长度 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s=App.Market_KamiNum.Generate&num=2&kami_num=3&kami_type=test&kami_desc=测试&kami_min_len=6&kami_max_len=6&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"kami_list": [
"vkqCuc",
"mNvnBD"
]
},
"msg": "小白开放接口:App.Market_KamiNum.Generate"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,9表示插件未安装 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.kami_list | 字符串 | 返回成功创建的卡密列表 |
data.kami_list[].kami | 字符串 | 新的卡密 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
接口路径(新):http://hn216.api.yesapi.cn/api/App/Market_KamiNum/Take
接口路径(旧):http://hn216.api.yesapi.cn/?s=App.Market_KamiNum.Take
接口描述: 根据数量卡密,判断是否存在,是否已使用,成功使用时返回卡密的相关信息。使用前请先安装卡密插件
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
---|---|---|---|---|---|
app_key | 字符串 | 必须 | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 | |
sign | 字符串 | 可选 | 公共参数接口签名,其中: | ||
uuid | 字符串 | 可选 | 公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 | ||
token | 字符串 | 可选 | 公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。 | ||
return_data | 字符串 | 可选 | 0 | 公共参数 数据返回结构,其中:
| |
kami | 字符串 | 必须 | 最小:6 | 卡密 |
查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名
请求:
{你的接口域名}/?s==App.Market_KamiNum.Take&kami=mNvnBD&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 2,
"err_msg": "卡密已使用",
"kami_detail": {
"kami": "mNvnBD",
"kami_type": "test",
"kami_desc": "测试",
"kami_num": 3,
"kami_note": ""
}
},
"msg": "小白开放接口:App.Market_KamiNum.Take"
}
返回字段 | 类型 | 说明 |
---|---|---|
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。当return_data=1时,接口只会返回此data字段。 |
data.err_code | 整型 | 操作码,0表示成功,1表示卡密不存在,2表示卡密已使用,9表示插件未安装 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.kami_detail | 对象 | 卡密的相关信息 |
data.kami_detail.kami | 字符串 | 卡密 |
data.kami_detail.kami_type | 字符串 | 卡密类型 |
data.kami_detail.kami_desc | 字符串 | 卡密描述 |
data.kami_detail.kami_num | 整型 | 卡密数量 |
data.kami_detail.kami_note | 字符串 | 卡密备注 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
_t | 整数 | 服务器当时Unix时间戳,例如:1657513450 |
_auth | 字符串 | 反向数字签名,可用于客户端进行反向验证,防止数据篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。验证算法:_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串) ,若需要关闭或开启请提交工单 |
特别注意:当前 hn216.api.yesapi.cn 为临时接口测试域名!请先完成 绑定独立接口域名后 ,才能正式进行API调用。
由 果创云YesApi.cn 提供技术支持,4万+开发者都在用,累计API调用1,800,000+万次