OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
model_name | String | Required | 数据库表名 | ||
database | String | Optaion | super | 自己的数据库配置标记,注意!这是数据库的配置标识,不是数据库的名称。默认使用super,不用传。如果需要配置多个数据库时,可与小白技术人员联系。重要事情说三遍,这是数据配置标识,不是数据库名称。使用此接口前,请先进入:数据库直连服务配置。 | |
field_name | String | Required | 需要匹配的表单字段名称 | ||
field_value | String | Required | 需要查找和对比的字段值 | ||
select | ArraySeperated with , | Optaion | 需要返回的字段,默认返回全部字段,多个字段用英文逗号分割,如:select=id,uuid |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
model_name | *Required | |
database | Option | |
field_name | *Required | |
field_value | *Required | |
select | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态操作码,0成功;1开发类错误,修改失败(表单不存在或字段类型不是数值类型);2应用层规则拦截,拦截后可以小白开放平台查看日记,3数据不存在或已删除 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
data | Object | 查找到的数据,如果未找到则为null。其中,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 |