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 | 使用此管理员系列接口时,忽略此参数。 | |
model_name | String | Required | Your table Model Name | ||
admin_uuid | String | Required | MIN: 32;MAX: 32 | 管理员的UUID,需要先在小白开放平台-会员列表-角色设置-角色-管理员,设置用户为管理员,然后传入用户的UUID | |
admin_token | String | Required | MIN: 64;MAX: 64 | 管理员的会话凭证 | |
other_uuid | String | Optaion | MIN: 32;MAX: 32 | 其他UUID,为避免混淆,当管理员要修改某位会员的数据时,可通过此参数指定修改特定uuid的数据。 | |
data | ArrayJSON Format | Optaion | 创建时的初始化数据,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...}。数据中的uuid将优先于model_uuid参数。JSON Parser Online | ||
check_field | ArraySeperated with , | Required | 待检测的字段。注意:data数据中必须包含待检测的全部字段。即check_field可指定data数据中的一个或多个字段。多个检测字段用英文逗号分割。例如:check_field=name,age,表示同时检测名字和年龄。请留意字段类型的相等性判断,如字符串类型的字段不能在data参数中传整型参数。 | ||
logic | Enum | Optaion | and | Range: and/or | 多个check_field的逻辑组合,logic=and表示逻辑且,logic=or表示逻辑或 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
uuid | Option | |
token | Option | |
model_name | *Required | |
admin_uuid | *Required | |
admin_token | *Required | |
other_uuid | Option | |
data | Option | |
check_field | *Required | |
logic | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功;1创建失败(不符合表字段要求,或表字段不存在);2应用层规则拦截,拦截后可以小白开放平台查看日记; |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
id | Int | 新创建数据的自增ID/或原来数据的ID |
op_type | String | 本次操作的具体类型,insert为插入,update为更新 |
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 |