YesApi 接口文档

6701 生成时间卡密接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_Kami/Generate

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_Kami.Generate

接口描述： 生成单个或多个时间卡密。注意，当卡密生成过多时，有可能批量生成的数量不足于指定的数量，建议卡密长度设置长一点，避免碰撞。当不足时，再次请求接口进行生成。使用前请先安装卡密插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
num整型可选1最小：1；最大：100需要生成的卡密数量
expire_seconds整型可选60最小：60卡密被领取后有效使用时间，单位：秒，例如一天则传86400
kami_min_len整型可选6最小：6卡密的最小字符长度
kami_max_len整型可选6最小：6；最大：100卡密的最大字符长度
more_data字符串JSON格式可选[]更多数据，统一初始化生成时设置的自定义数据，JSON格式，字段为表单字段名称，必须先在表单添加新字段。例如：more_data={"beizhu":"备注数据"}

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Market_Kami.Generate&num=2&expire_seconds=60&kami_min_len=6&kami_max_len=6

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "kami_list": [
            "m17BfI",
            "0WTjFv"
        ]
    },
    "msg": "小白开放接口：App.Market_Kami.Generate"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/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密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

6702 使用时间卡密接口

接口路径(新)：http://api.yesapi.cn/api/App/Market_Kami/Take

接口路径(旧)：http://api.yesapi.cn/?s=App.Market_Kami.Take

接口描述： 根据时间卡密，判断是否存在，是否已使用，存在返回卡密的有效使用时间。使用前请先安装卡密插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
kami字符串必须最小：6卡密
kami_client_code字符串可选最大：200机器码，可为空。如果最初使用时有传此机器码，则后续需要继续传递此机器码则可以继续使用；并且在初次使用绑定机器码后，其他机器码或空机器码将不能再使用。
more_data字符串JSON格式可选[]更多数据，成功使用时设置的更多数据，JSON格式，字段为表单字段名称，可自行添加新字段。例如：more_data={"beizhu":"备注数据"}
more_select字符串用,分割可选更多返回字段，多个字段用逗号分割。例如：more_select=beizhu

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?s=App.Market_Kami.Take&kami=0WTjFv&app_key={你的app_key}&sign={动态签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "kami_detail": {
            "kami_expire_seconds": 60,
            "kami_client_code": "abc",
            "kami_taken_time": "2019-10-30 15:39:01",
            "ip": "",
            "kami_expire_time": "2019-10-30 15:40:15"
        }
    },
    "msg": "小白开放接口：App.Market_Kami.Take"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，1表示卡密不存在，2表示卡密已使用，3表示卡密已过期，4表示机器码不正确，9表示插件未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.kami_detail对象卡密的相关信息
data.kami_detail.kami_expire_time字符串卡密存在时返回，卡密使用的截止有效日期时间，等于成功领取的时间加上有效使用时间，如：2019-10-30 00:00:19
data.kami_detail.kami_client_code字符串机器码
data.kami_detail.kami_taken_time字符串激活时间
data.kami_detail.ip字符串领取的IP
data.kami_detail.kami_expire_seconds整型卡密存在时返回，有效使用时间，相对时间，单位:秒
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 api.yesapi.cn 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次