应用开放API
应用开放API是一些预先 定义的函数，目的是提供应用程序与开发人员基于某软件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。用户使用 规定的格式调用 API 即可获取相应信息。
访问入口
每个应用创建后，会自动创建对应的API接口，应用管理员可查看接口文档，也可以将接口文档分享给开发者。
文档查看入口：「 应用设置 》应用开放API 」。
授权管理
授权
删除
IP 白名单
💥 Tips：
启用IP白名单后，仅允许名单内的IP地址访问服务；若未设置白名单，则所有IP均可正常发起请求。
具体接口列表如下
-
应用信息
- 获取应用信息 GET
-
表单
- 获取字段信息
- 获取列表
- 新建行数据
- 批量新建行数据
- 获取行数据详情
- 更新行数据
- 批量更新行数据
- 删除行数据
- 获取关联数据
- 获取表单总行数
- 获取行分享链接
-
应用角色
- 获取应用角色列表
- 创建应用角色
- 删除应用角色
- 添加应用角色成员
- 移除应用角色成员
- 获取用户应用角色
-
选项集
- 新增选项集
- 获取选项集
- 编辑选项集
-
地区
- 地区信息
操作符
| 操作符 | 说明 |
|---|---|
| contain | 包含 |
| lcn | 开头为 |
| rcn | 结尾为 |
| eq | 等于 |
| ne | 不等于 |
| lt | 小于 |
| le | 小于或等于 |
| gt | 大于 |
| ge | 大于或等于 |
| in | 是否在指定集合内 |
💥 Tips：
这些操作符通常用于数据查询，可以帮助构建精确的筛选条件。
错误码
以下是系统错误码及其含义的详细说明：
| ErrorCode | 说明 |
|---|---|
| 10000 | 成功 |
| 20000 | 失败 |
| 50001 | 无效的 appKey |
| 50002 | 签名不合法 |
| 50003 | 签名已过期 |
| 50004 | IP 未授权 |
| 50005 | 非法 URL |
| 50006 | 暂无权限 |
| 50010 | 应用已被删除 |
| 50011 | 应用已被禁用 |
| 50012 | 应用正在维护中 |
| 50013 | 系统繁忙，请稍后重试 |
| 50014 | 参数缺失 |
常见错误处理建议：
- 50001、50002、50003：检查
appKey和签名是否正确，确保时间戳未过期。 - 50004：确认请求 IP 是否在授权白名单内。
- 50005：检查请求的 URL 是否符合规范。
- 50006、50010、50011：联系管理员确认应用权限或状态。
- 50013：稍后重试或联系技术支持。
- 50014：检查请求参数是否完整。
控件类型
| 控件代码 (code) | 说明 | 适用场景 |
|---|---|---|
| TextField | 单行文本输入框 | 用户名、标题、短文本输入 |
| TextareaField | 多行文本输入框 | 描述、备注、长文本内容 |
| NumberField | 数值输入框 | 年龄、数量、金额等数字输入 |
| RadioField | 单选按钮 | 性别、状态等单选场景 |
| CheckboxField | 多选框 | 兴趣、标签等多选场景 |
| GradeField | 评分/等级选择器 | 满意度评分、星级评价 |
| DateField | 日期选择器 | 出生日期、预约日期 |
| CascadeSelectField | 级联选择框 | 省市区选择、多级分类 |
| ImageField | 图片上传控件 | 头像、产品图片上传 |
| AttachmentField | 附件上传控件 | 文件、文档上传 |
| EditorField | 富文本编辑器 | 文章内容、详情编辑（支持图文排版） |
| LocationField | 地理位置选择器 | 地图定位、地址选择 |
| DigitalSignatureField | 手写签名 | 电子签名、审批确认 |
| TableField | 子表格 | 表格数据录入 |
| EmployeeField | 成员 | 组织成员选择 |
| DepartmentSelectedField | 部门 | 部门选择 |
| AddressField | 地区 | 地址选择 |
| FormulaField | 公式 | 自动计算字段 |
| OfficeField | 正文控件 | Office文档编辑 |
| AssociationFormField | 关联数据 | 关联其他表单数据 |
| CollectField | 汇总 | 数据汇总统计 |
| UppercaseAmountField | 大写金额 | 财务金额大写显示 |
| IframeField | 嵌入 | 嵌入外部网页 |
| AutoNoField | 自动编号 | 自动生成编号 |
| Array | 数组 | 数组数据存储 |
| Object | 对象 | 对象数据存储 |
使用说明：
- 文本类控件（
TextField、TextareaField、EditorField）适用于不同长度的文本输入需求。 - 选择类控件（
RadioField、CheckboxField、CascadeSelectField）适用于固定选项的场景。 - 文件类控件（
ImageField、AttachmentField）需注意文件格式和大小限制。 - 特殊控件（
GradeField、LocationField）需结合业务逻辑配置。 - 复杂数据结构 可使用Array和Object类型存储。
- 自动编号(AutoNoField) 常用于生成业务单据编号。
调用API注意事项
- 通过API获取记录列表最多能获取1000行
👇文档问题反馈
- 文档中是否有错别字、内容过期、难以理解等问题？点此反馈给我们