OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
uuid | String | Optaion | MIN: 32;MAX: 32 | 用户的UUID | |
token | String | Optaion | MIN: 64;MAX: 64 | 不需要用户登录 | |
type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
name | String | Required | MIN: 1;MAX: 64 | 计数器名称 | |
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 | |
value | Int | Required | 1 | 待增量更新的值,为正数时增加,为负数则减少 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
uuid | Option | |
token | Option | |
type | *Required | |
name | *Required | |
admin_uuid | *Required | |
admin_token | *Required | |
value | *Required |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功,1计数器不存在 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
before_value | Int | 更新前原来的值 |
after_value | Int | 更新后的值 |
add_value | Int | 服务端实际累加的值(尽可能累加的值,即在不超出最值的情况下尽最大可能累加的值) |
value | 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 |