OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| model_name | String | Required | 表单名称（对应在小白开放平台创建时的数据库表名称），查看我的全部表单 | ||
| model_uuid | String | Optaion | null | MAX: 32 | 表单UUID，即对应表单数据里的uuid字段。分为三种情况： model_uuid为@NULL或未提供时（默认值）：如model_uuid=@NULL，即不限制uuid，可匹配任意uuid，包括uuid为空和不为空的数据纪录； model_uuid为空字符串：为空字符串时，如model_uuid=，只匹配uuid为空字符串的数据纪录（即游客数据）； model_uuid为具体的值：如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A，则进行精确匹配，只匹配与表单uuid相等的数据纪录。 |
| check_code | String | Optaion | MAX: 64 | 待检测的口令，仅当在小白开放平台配置口令后才会对此参数进行检测，规则配置教程，图解自定义表单规则.pdf |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| model_name | *Required | |
| model_uuid | Option | |
| check_code | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 状态操作码，0成功；1开发类错误，查询失败(表单不存在或查询错误)；2应用层规则拦截，拦截后可以小白开放平台查看日记 |
| err_msg | String | 错误提示信息，err_code非0时参考此提示信息 |
| list | Array | 查询的结果列表数据 |
HTTP Response Code
| HTTP Status Code | Description |
|---|---|
| Http Status = 200 | Success |
| Http Status = 400 | 非法请求，参数错误 |
| Http Status = 401 | 用户未登录，或登录凭证已过期 |
| Http Status = 402 | IP已被黑名单拦截 |
| Http Status = 403 | IP未命中白名单 |
| Http Status = 404 | 接口服务不存在 |
| Http Status = 406 | 非法app_key，请核对你所在的接口域名 |
| Http Status = 407 | 当前应用已过期 |
| Http Status = 408 | 当前应用存在异常，已被封号 |
| Http Status = 409 | 签名错误 |
| Http Status = 410 | 权限不足，非系统管理员 |
| Http Status = 411 | 权限不足，应用管理员未登录 |
| Http Status = 412 | 权限不足，非应用管理员 |
| Http Status = 413 | 本月接口流量超出，已被临时冻结 |
| Http Status = 414 | 并发过高 |
| Http Status = 415 | 接口已被开发者关闭 |
| Http Status = 416 | 权限不足，个人免费版套餐无法使用专业版接口 |
| Http Status = 417 | 子应用异常，如：子应用签名错误/已过期/流量不足 |
| Http Status = 500 | 如果出现此错误，请联系技术人员处理 |