跳到主要内容

集群模式本地OpenAPI开放

在专属集群环境中宜搭完全在本地环境中运行,因此你无需再次调用钉钉开放平台宜搭 OpenAPI,只需调用集群环境中的 OpenAPI 即可。本文介绍在专属集群环境中如何调用宜搭OpenAPI。

说明:

目前专属宜搭已经将高频的数据服务接口进行了接口开放。基于2023.12月31的钉钉开放平台宜搭接口能力,共计 52 个 OpenAPI。

如何接入宜搭接口能力

钉钉提供了宜搭接口接入流程示例。

调用流程

集群环境中调用宜搭接口步骤与公共环境类似,在调用接口时,你只需将公共环境的 Host 请求地址换为为绑定组织宜搭的域名即可。例如:abc.aliwork.com

  1. 创建一个钉钉应用。

应用由交付人员在钉钉开发平台本组织内新建应用,应用名为:宜搭专属集群专用应用

  1. 添加接口调用权限。应用创建后默认只开放登录和消息通知接口的调用权限,交付人员会根据开发需要,添加对应的接口使用权限。
  2. 调用/v1.0/oauth2/accessToken接口,获取应用的 access_token。接口请求参数请参考获取企业内部应用的access_token

access_token默认有效期2小时。

  1. 使用access_token调用宜搭接口。

钉钉开放平台提供了Java、PHP、Python、.NET SDK供开发者使用。

说明:

企业内部应用、第三方企业应用的服务端SDK是相同的,点击以下任一链接均可下载。

集群接口列表清单

宜搭提供了丰富的接口开放能力,开发者通过API接口可以实现宜搭和企业业务系统打通。目前主要开放了表单、流程、应用领域的接口。

所属模块

标准服务端API

说明

流程

发起宜搭审批流程

发起宜搭审批流程到钉钉开放平台。

删除流程实例

删除流程实例。

终止流程实例

终止流程实例。

获取实例ID列表

获取实例ID列表。

批量获取流程实例列表

根据流程实例ID,批量获取对应的流程实例详情。

获取流程实例

获取宜搭的流程实例信息。

根据流程实例ID获取流程实例

根据指定流程实例ID获取流程实例详情。

表单

获取指定应用下的表单列表

分页获取应用下的表单列表。

获取表单内的组件信息

根据表单ID,获取单据或流程表单内的组件信息。

查询表单实例数据

查询表单实例数据。

保存表单数据

新增一条无审批流程的宜搭表单实例。

更新表单数据

更新表单数据。

查询表单数据

通过表单实例ID查询表单数据。

获取员工组件的值

获取员工组件的值。

获取表单组件定义列表

获取表单组件定义列表。

获取子表组件数据

通过表单实例ID和子表组IDd获取子表组件数据。

删除表单数据

删除表单数据。

获取多个表单实例ID

获取多个表单实例ID。

批量获取表单实例数据

批量获取表单实例详情信息。

批量删除表单实例

批量删除表单实例数据。

批量创建表单实例

批量创建表单实例数据。

批量更新表单实例内的组件值

根据宜搭表单实例Id,批量更新宜搭表单实例的组件值。

新增或更新表单实例

使用筛选条件新增或更新表单实例。

通过高级查询条件获取表单实例数据(包括子表单组件数据)

使用筛选条件获取表单实例详情。

通过高级查询条件获取表单实例数据(不包括子表单组件数据)

使用筛选条件获取表单实例详情,不包括子表单组件数据。

通过表单实例数据批量更新表单实例

根据宜搭表单组件数据,批量更新表单实例信息。

查询表单的变更记录

查询表单的变更记录

审批任务

获取审批记录

获取审批记录。

同意或拒绝宜搭审批任务

同意或拒绝宜搭审批任务。

转交任务

转交任务。

提交评论

提交表单或流程实例下的评论。

批量查询宜搭表单实例的评论

批量查询宜搭表单下的所有评论。

应用

查询宜搭应用列表

查询组织下的宜搭应用列表。


Copyright © 2024钉钉(中国)信息技术有限公司和/或其关联公司浙ICP备18037475号-4