OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
page | Int | Optaion | 1 | 第几页 | |
perpage | Int | Optaion | 20 | MAX: 1000 | 分页数量 |
role | String | Optaion | all | 管理员为"admin"用户为"user"全部为"all" | |
sort_type | Int | Optaion | 1 | 1注册时间降序,2注册时间升序,3账号名降序,4账号名升序 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
page | Option | |
perpage | Option | |
role | Option | |
sort_type | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
users | Array | 会员列表 |
users[].uuid | String | 会员UUID |
users[].username | String | 会员账号 |
users[].role | String | 会员角色,admin是管理员,user是普通用户 |
users[].role_desc | String | 会员角色说明 |
users[].status | Int | 会员状态,0正常,1已被封号 |
users[].status_desc | String | 会员状态说明 |
users[].reg_time | String | 注册时间 |
users[].ext_info | Object | 通过修改用户扩展信息接口修改的特定会员扩展信息,通过默认会员扩展信息配置可以设置默认扩展信息。 |
total | 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 |