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 | ||
select | String | Optaion | * | SQL语句的SELECT部分,如:select=id,uuid | |
where | String | Optaion | SQL语句的WHERE部分,如:where=id > 1 | ||
order | String | Optaion | id DESC | SQL语句的ORDER部分,如:order=id DESC | |
page | Int | Optaion | 1 | MIN: 1 | 第几页 |
perpage | Int | Optaion | 10 | MIN: 1;MAX: 10000 | 分页数量 |
return_sql | Boolean | Optaion | false | 是否需要返回当前查询的sql片段,默认不返回,调试时可开启 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
model_name | *Required | |
select | Option | |
where | Option | |
order | Option | |
page | Option | |
perpage | Option | |
return_sql | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功;1开发类错误,查询失败(表单不存在或查询错误);2应用层规则拦截,拦截后可以小白开放平台查看日记 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
total | Int | 数据的总条目数量 |
list | Array | 查询的结果列表数据 |
sql | Object | 经过解析后的SQL语句片段,便于开发人进行校对(return_sql为true时才返回) |
sql.select | String | 解析后的查询字段 |
sql.where | String | 解析后的查询条件 |
sql.order | String | 解析后的排序规则 |
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 |