通过数据接口(API)对简道云数据进行增/删/改

简道云提供了表单API和数据API,用于给具备编程能力的用户提供方法集成外部系统。

规则

  • API的统一访问地址为:https://www.jiandaoyun.com/api/v1
  • 所有 API 请求都必须通过HTTPS进行身份验证和发起
  • 统一采用 POST 请求的形式
  • 数据传输编码为 UTF-8
  • 所有数据均为 JSON 格式

频率限制

最多接受请求:5次/秒

鉴权方式

简道云使用基于简单令牌的身份验证(在 “账户中心” 生成或管理您的 APIKey )。

生成方式:账户中心 >> 账号设置 >> API Key

对于生成的APIKey 还可以进行重置和删除。

APIKey右侧的「API文档」是专门根据当前表单的配置生成的。

表单API

表单API提供了 「表单字段查询接口」

通过表单API可以获取指定表单的字段信息,除分割线字段和关联查询字段以外。 注意:表单字段一旦添加,则以widget为前缀的字段ID将不再会发生变更。如果您删除/添加字段或者修改字段标题,则该文档里所对应的表单字段的其他信息也会相应更改。

数据API

数据API所提供的接口有以下五种:

(1)查询多条数据接口

(2)查询单条数据接口

通过API接口查询到的数据支持过滤,可通过filter参数进行数据过滤。 查询到的数据内容中,除了表单字段以外,还有一些系统字段。

系统字段有:appId、entryId、数据ID、扩展字段、提交时间、提交人、修改时间、修改人、流程状态(仅流程表单)

(3)新建单条数据接口

使用该接口可以在指定表单中添加一条数据。 目前系统字段和以下所列举的字段不支持添加和修改数据: 分割线、图片、附件、手写签名、成员单选、成员多选、部门单选、部门多选、关联数据、关联查询

(4)修改单条数据接口

按照指定数据ID修改表单中的数据。 使用API修改数据时,会触发的事件有聚合表计算&校验、数据操作日志、数据量统计。不进行重复值校验、必填校验等。

(5)删除单条数据接口

按照指定数据ID从表单中删除数据。

有了以上数据接口,我们可以通过表单API和数据API将第三方新增/更新的数据写入简道云,也可以通过第三方查询简道云的数据,方便了团队成员处理多方系统的数据。

具体使用帮助可以参考帮助文档「表单&数据API」

数据接口目前仅提供给定制版用户,如有功能使用需求可以联系我们。

在线咨询:商务咨询

商务电话:400-111-0890

定制意向:意向填写

Peach是此帮助页面的作者。如果您对此页面的内容有任何意见,请在下方给她反馈。如需获取即时帮助,请联系技术支持。
本文是否对您有帮助?