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,全局唯一用户ID | |
| token | String | Optaion | MIN: 64;MAX: 64 | 会话凭证 | |
| type | Enum | Required | Range: hour/day/week/month/year/forever | 计数器类型,时/日/周/月/年/永久计数器 | |
| name | String | Optaion | MIN: 1;MAX: 64 | 计数器名称,支持模糊匹配,为空时取全部 | |
| num | Int | Optaion | 100 | 排行榜前面多少个 | |
| start_time | String | Optaion | 开始时间,未指定时取当前相应的时间周期,示例:2020-05-14 14:29:12 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| uuid | Option | |
| token | Option | |
| type | *Required | |
| name | Option | |
| num | Option | |
| start_time | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
| err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
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 |