OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
domain_key | String | Required | 服务端标识 | ||
assign_ip | String | Optaion | 管理员手动指定的IP,如未指定时动态取当前请求的IP地址。 | ||
local_update_time | String | Required | 本地时间,格式:Y-m-d H:i:s,如:2019-06-23 00:09:00,若本地时间与当前时间误差较大,将会直接抛弃。 | ||
check_seconds | Int | Optaion | 60 | MIN: 1;MAX: 300 | 本地时间与服务器时间之间,允许的时间误差,单位:秒。默认允许误差是正负一分钟。 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
domain_key | *Required | |
assign_ip | Option | |
local_update_time | *Required | |
check_seconds | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,1表示IP地址非法(指定的IP格式错误,或者无法获取当前IP),2表示时间误差过大,3表示插件未安装 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
final_ip | String | 最终记录的IP |
update_time | String | 本次更新时间,如:2019-06-23 23:18:25 |
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 |