OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| user_role | String | Optaion | MAX: 20 | 会员分组，小白的会员角色，user表示普通用户，admin表示管理员，同时支持自定义分组 | |
| assign_user | String | Optaion | MAX: 32 | 授权的用户，对应小白会员的UUID | |
| menu_key | String | Required | MAX: 255 | 客户端软件应用的菜单项，可以是菜单、URL或者其他，用于程序判断 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| user_role | Option | |
| assign_user | Option | |
| menu_key | *Required |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作状态码，0成功，9插件表单未安装 |
| 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 |