OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
model_name | String | Required | Your table Model Name | ||
logic | Enum | Optaion | and | Range: and/or | Where condition logic, logic=and for logical and, logic=or for logical or |
field_name_list | ArraySeperated with , | Required | MIN: 1 | 需要匹配的表单字段名称列表,多个字段用英文逗号分割,如:field_name_list=title,name | |
field_value_list | ArraySeperated with , | Required | MIN: 1 | 需要查找和对比的字段值列表,多个值用英文逗号分割,如:field_value_list=标题,小白 。字段值不能含有英文逗号。field_value_list数量必须和field_name_list数量保持一致。 | |
select | ArraySeperated with , | Optaion | 需要返回的字段,默认返回全部字段,多个字段用英文逗号分割,如:select=id,uuid | ||
page | Int | Optaion | 1 | MIN: 1 | 第几页 |
perpage | Int | Optaion | 20 | MIN: 1;MAX: 10000 | 分页数量 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
model_name | *Required | |
logic | Option | |
field_name_list | *Required | |
field_value_list | *Required | |
select | Option | |
page | Option | |
perpage | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功;1开发类错误;2应用层规则拦截,拦截后可以小白开放平台查看日记 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
items | Object | 查找到的数据列表,如果未找到则为空数组。默认返回20条,ID升序获取。 |
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 |