OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
kami | String | Required | MIN: 6 | 卡密 | |
kami_client_code | String | Optaion | MAX: 200 | 机器码,可为空。如果最初使用时有传此机器码,则后续需要继续传递此机器码则可以继续使用;并且在初次使用绑定机器码后,其他机器码或空机器码将不能再使用。 | |
more_data | ArrayJSON Format | Optaion | [] | 更多数据,成功使用时设置的更多数据,JSON格式,字段为表单字段名称,可自行添加新字段。例如:more_data={"beizhu":"备注数据"} | |
more_select | ArraySeperated with , | Optaion | 更多返回字段,多个字段用逗号分割。例如:more_select=beizhu |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
kami | *Required | |
kami_client_code | Option | |
more_data | Option | |
more_select | 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-30 00: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 | 卡密存在时返回,有效使用时间,相对时间,单位:秒 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |