跳到主要内容

服务端开放API

宜搭平台除了提供用于在 Client 端调用的开放 API,还提供了支持通过服务端进行调用的开放 API,具体详见钉钉开放平台文档

使用指南

使用宜搭平台服务端开放 API 的步骤如下所示:

tip

钉钉开放平台提供多种应用类型,不同应用类型使用服务端开放API的方式有所不同,具体请查看钉钉应用类型介绍文档

步骤 1:创建钉钉应用

步骤 2:添加接口调用权限

应用创建后默认只开放登录和消息通知接口的调用权限,您需要根据开发需要,添加对应的接口使用权限。

步骤 3:获取应用的 access_token

access_token 相当于是身份凭证。调用接口时,通过 access_token 来鉴权调用者身份。

API列表

流程

接口说明企业内部应用第三方企业应用第三方个人应用权限
发起宜搭审批流程支持支持暂不支持宜搭流程数据写权限
删除流程实例支持支持暂不支持宜搭流程数据写权限
终止流程实例支持支持暂不支持宜搭流程数据写权限

表单

接口说明企业内部应用第三方企业应用第三方个人应用权限
查询表单实例数据支持支持暂不支持宜搭表单数据读权限
保存表单数据支持支持暂不支持宜搭表单数据写权限
更新表单数据支持支持暂不支持宜搭表单数据写权限
查询表单数据支持支持暂不支持宜搭表单数据读权限
获取员工组件的值支持支持暂不支持宜搭表单数据读权限
获取表单组件定义列表支持支持暂不支持宜搭表单数据读权限
获取子表组件数据支持支持暂不支持宜搭表单数据读权限
获取流程定义支持支持暂不支持宜搭流程数据读权限
删除表单数据支持支持暂不支持宜搭表单数据写权限
获取多个表单实例ID支持支持暂不支持宜搭表单数据读权限

任务

接口说明企业内部应用第三方企业应用第三方个人应用权限
获取审批记录支持支持暂不支持宜搭流程数据读权限
同意或拒绝宜搭审批任务支持支持暂不支持宜搭流程数据写权限
获取组织内某人提交的任务支持支持暂不支持宜搭流程数据读权限
获取组织内已完成的审批任务支持支持暂不支持宜搭任务读权限
转交任务支持支持暂不支持宜搭任务写权限
获取实例ID列表支持支持暂不支持宜搭流程数据读权限
查询流程运行任务(VPC)支持支持暂不支持宜搭任务读权限
批量获取流程实例列表支持支持暂不支持宜搭流程数据读权限
获取任务列表(组织维度)支持支持暂不支持宜搭任务读权限
获取流程实例支持支持暂不支持宜搭流程数据读权限
获取发送给用户的通知支持支持暂不支持宜搭任务读权限
根据流程实例ID获取流程实例支持支持暂不支持宜搭流程数据读权限
查询抄送我的任务列表(应用维度)支持支持暂不支持宜搭任务读权限
提交评论支持支持暂不支持宜搭评论写权限

附件

接口说明企业内部应用第三方企业应用第三方个人应用权限
获取宜搭附件临时免登地址支持支持暂不支持宜搭流程数据读权限