OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| num | Int | Optaion | 20 | MAX: 1000 | 需要返回的会员数量 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| num | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
| err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
| members | Array | 会员列表,没有时为空数组 |
| members[].uuid | String | 会员UUID |
| members[].client | String | 会员登录时的客户端,没有时为空字符串 |
| members[].login_time | String | 登录时间 |
| members[].ip | String | 登录IP,没有时为空字符串 |
| members[].username | String | 会员账号 |
| members[].role | String | 会员角色,user为普通会员,admin为管理员,其他值为自定义角色 |
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 |