OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
return_data | String | Optaion | 0 | 公共参数 数据返回结构,其中: return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"}; return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}。 | |
kami | String | Required | MIN: 6 | 卡密 | |
kami_client_code | String | Optaion | MAX: 200 | 机器码,可为空。如果最初使用时有传此机器码,则后续需要继续传递此机器码则可以继续使用;并且在初次使用绑定机器码后,其他机器码或空机器码将不能再使用。 | |
more_data | Array | Optaion | 更多数据,成功使用时设置的更多数据,JSON格式,字段为模型字段名称,可自行添加新字段。例如:more_data={"beizhu":"备注数据"} | ||
more_select | Array | Optaion | 更多返回字段,多个字段用逗号分割。例如:more_select=beizhu | ||
leixing | String | Optaion |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
return_data | Option | |
kami | *Required | |
kami_client_code | Option | |
more_data | Option | |
more_select | Option | |
leixing | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,1表示卡密不存在,2表示卡密已使用,3表示卡密已过期,4表示机器码不正确,9表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
kami_detail | Object | 卡密的相关信息 |
kami_detail.kami_expire_time | String | 卡密存在时返回,卡密使用的截止有效日期时间,等于成功领取的时间加上有效使用时间,如:2019-10-3000:00:19 |
kami_detail.kami_client_code | String | 机器码 |
kami_detail.kami_taken_time | String | 激活时间 |
kami_detail.ip | String | 领取的IP |
kami_detail.kami_expire_seconds | Int | 卡密存在时返回,有效使用时间,相对时间,单位:秒 |
leixing | String | 暂无描述 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | 非法请求,参数错误 |
Http Status = 401 | 用户未登录,或登录凭证已过期 |
Http Status = 402 | IP已被黑名单拦截 |
Http Status = 403 | IP未命中白名单 |
Http Status = 404 | 接口服务不存在 |
Http Status = 406 | 非法app_key,请核对你所在的接口域名 |
Http Status = 407 | 当前应用已过期 |
Http Status = 408 | 当前应用存在异常,已被封号 |
Http Status = 409 | 签名错误 |
Http Status = 410 | 权限不足,非系统管理员 |
Http Status = 411 | 权限不足,应用管理员未登录 |
Http Status = 412 | 权限不足,非应用管理员 |
Http Status = 413 | 本月接口流量超出,已被临时冻结 |
Http Status = 414 | 并发过高 |
Http Status = 415 | 接口已被开发者关闭 |
Http Status = 416 | 权限不足,个人免费版套餐无法使用专业版接口 |
Http Status = 417 | 子应用异常,如:子应用签名错误/已过期/流量不足 |
Http Status = 500 | 如果出现此错误,请联系技术人员处理 |