概览
金数据 API v1 是一套基于 HTTP RESTful 风格的接口能力,使用 API Key / Secret 进行安全认证。你可以通过 API 读取表单结构、查询表单数据、创建和更新数据,并将金数据接入业务系统、自动化流程或内部工具。
适合什么场景
API v1 适合需要通过程序读取、创建、修改或同步金数据表单与数据的系统集成场景。
你可以用 API v1:
- 将表单数据同步到 CRM、工单系统、运营后台或数据仓库
- 在业务系统中读取表单结构和提交数据
- 通过程序创建、更新或删除表单数据
- 查询当前账号、企业成员和套餐信息
快速开始
如果你是第一次接入 API v1,建议按下面的顺序开始:
- 查看 认证方式,获取 API Key 和 API Secret
- 查看 接口列表,找到你需要调用的接口
- 查看 Schema,了解表单结构和数据结构
- 查看 状态码,了解常见错误和处理方式
- 查看 请求速率,确认调用限制
金数据 API v1 的可用能力会根据账号套餐和权限有所不同。接入前,请先确认当前账号是否已开启对应 API 权限。
能力范围
| 功能 | 免费版 | 专业版/专业增强版 | 企业基础版 | 企业协作版 | 企业高级版 |
|---|---|---|---|---|---|
| 通过 API 操控账号所属表单 | ✔️ | ✔️ | ✔️ | ||
| 通过 API 操控企业全部表单 | ✔️ | ✔️ | ✔️ | ||
| 获取表单列表/表单结构 | ✔️ | ✔️ | ✔️ | ||
| 创建/编辑/复制表单 | ✔️ | ✔️ | ✔️ | ||
| 编辑表单主题 | ✔️ | ✔️ | ✔️ | ||
| 获取文件夹列表/创建文件夹 | ✔️ | ✔️ | ✔️ | ||
| 移动表单到/移出文件夹 | ✔️ | ✔️ | ✔️ | ||
| 获取表单数据列表 | ✔️ | ✔️ | ✔️ | ||
| 创建数据 | ✔️ | ✔️ | ✔️ | ||
| 获取单条数据 | ✔️ | ✔️ | ✔️ | ||
| 变更/删除数据 | ✔️ | ✔️ | ✔️ |