Skip to main content
开启专属集群环境的应用数据保存在私有环境中,且无法出网,因此钉钉开放平台的宜搭 OpenAPI是无法获取数据的.需调用集群环境中的 OpenAPI 。集群环境中的 OpenAPI与钉钉开放平台的基本一致,只是host和所需的ak/sk不同. 本文介绍在专属集群环境中如何调用宜搭OpenAPI。
说明:目前专属宜搭已经将高频的数据服务接口进行了接口开放。基于2023.12月31的钉钉开放平台宜搭接口能力,共计 52 个 OpenAPI。

调用流程

集群环境中调用宜搭接口步骤与钉钉开放平台类似,钉钉开放平台相关OpenAPI都是调用api.dingtalk.com,集群的OpenAPI把api.dingtalk.com替换成自己组织的集群版宜搭域名即可。
  1. 获取你组织的宜搭专属集群的域名地址,比如域名为 ddyd.corp.com
  2. 获取当前组织的集群版对应的AK和SK
联系自己组织的钉钉组织管理员,登录钉钉开放平台,在企业内部应用中搜索 “宜搭专属集”,在名为【宜搭专属集群鉴权应用】中获取相关信息
1

步骤 1

使用上一步获取的AK/SK调用 /v1.0/oauth2/accessToken 接口,获取应用的 access_token。接口请求参数请参考 获取企业内部应用的access_token 。
2

使用access_token调用宜搭接口

钉钉开放平台提供了Java、PHP、Python、.NET SDK供开发者使用。集群的OpenAPI也支持类似调用.
企业内部应用、第三方企业应用的服务端SDK是相同的,点击以下任一链接均可下载。
  • 企业内部应用, 服务端SDK下载 。
  • 第三方企业应用, 服务端SDK下载 。
  1. 如果你使用的钉钉开放平台的SDK,可以做如下改动
改动一:如果域名是http的,需要设置config.protocol = “http” 改动二:需要显式设置client._endpoint为你组织宜搭的真实域名

集群接口列表清单

宜搭提供了丰富的接口开放能力,开发者通过API接口可以实现宜搭和企业业务系统打通。目前主要开放了表单、流程、应用领域的接口。
所属模块标准服务端API说明
流程发起宜搭审批流程发起宜搭审批流程到钉钉开放平台。
删除流程实例删除流程实例。
终止流程实例终止流程实例。
获取实例ID列表获取实例ID列表。
批量获取流程实例列表根据流程实例ID,批量获取对应的流程实例详情。
获取流程实例获取宜搭的流程实例信息。
根据流程实例ID获取流程实例根据指定流程实例ID获取流程实例详情。
表单获取指定应用下的表单列表分页获取应用下的表单列表。
获取表单内的组件信息根据表单ID,获取单据或流程表单内的组件信息。
查询表单实例数据查询表单实例数据。
保存表单数据新增一条无审批流程的宜搭表单实例。
更新表单数据更新表单数据。
查询表单数据通过表单实例ID查询表单数据。
获取员工组件的值获取员工组件的值。
获取表单组件定义列表获取表单组件定义列表。
获取子表组件数据通过表单实例ID和子表组IDd获取子表组件数据。
删除表单数据删除表单数据。
获取多个表单实例ID获取多个表单实例ID。
批量获取表单实例数据批量获取表单实例详情信息。
批量删除表单实例批量删除表单实例数据。
批量创建表单实例批量创建表单实例数据。
批量更新表单实例内的组件值根据宜搭表单实例Id,批量更新宜搭表单实例的组件值。
新增或更新表单实例使用筛选条件新增或更新表单实例。
通过高级查询条件获取表单实例数据(包括子表单组件数据)使用筛选条件获取表单实例详情。
通过高级查询条件获取表单实例数据(不包括子表单组件数据)使用筛选条件获取表单实例详情,不包括子表单组件数据。
通过表单实例数据批量更新表单实例根据宜搭表单组件数据,批量更新表单实例信息。
查询表单的变更记录查询表单的变更记录
审批任务获取审批记录获取审批记录。
同意或拒绝宜搭审批任务同意或拒绝宜搭审批任务。
转交任务转交任务。
提交评论提交表单或流程实例下的评论。
批量查询宜搭表单实例的评论批量查询宜搭表单下的所有评论。
应用查询宜搭应用列表查询组织下的宜搭应用列表。