概述
业务介绍
接入流程
编号 | 步骤 | 介绍 |
---|---|---|
1 | 创建一个应用 | 如需创建企业自建应用,可参考 自建应用的开发流程如需创建应用商店应用,可参考 开发和上架应用商店应用 |
2 | 调用API,对审批进行操作 | 调用API前,你需要先获取访问凭证并开启对应的权限,详情参见 如何调用服务端API。 |
3 | 监听事件,获知审批状态的变化 | 监听事件前,你需要先申请相应的权限,审批事件监听开发指南 |
开发教程
教程名称 | 教程步骤拆解 |
---|---|
快速开发三方审批![]() | 教程步骤拆解简介准备工作创建应用和申请权限获取访问凭证创建和更新三方审批定义三方审批实例同步发送与更新审批bot消息三方快捷审批三方审批实例校验 |
资源介绍
资源 | 资源定义 |
---|---|
审批定义 | 单个审批流,由表单和审批流程组成,创建后可以让员工在发起审批时填写各个控件的值并形成审批实例。 |
审批实例 | 员工发起审批时产生的审批流。包括多个审 批任务 |
审批任务 | 审批任务依赖于审批节点存在,每一个审批节点可能包含有一或多个审批任务,每一个任务表明当前审批节点的审批人是谁 |
审批评论 | 员工在审批实例中进行的评论或评论回复。 |
文件 | 当审批表单中有图片或附件控件时,开发者需在创建审批实例前通过审批上传文件接口将文件上传到审批系统。 |
三方审批定义 | 三方审批定义是审批的描述,包括审批名称、图标、描述、分组等基础信息。三方将根据三方审批定义来创建和同步三方审批实例 |
三方审批实例 | 员工发起审批时产生的审批流。包括多个审批任务、审批抄送等信息 |
三方审批任务 | 审批人每一个审批的操作对应着一个审批任务 |
资源:审批定义 Approval
方法列表
方法 (API) | 权限要求 | 访问凭证 | ||
---|---|---|---|---|
创建审批定义POST /open-apis/approval/v4/approval | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token | ||
查看审批定义GET /open-apis/approval/v4/approvals/:approval_code | 访问审批应用 | tenant_access_token | ||
订阅审批事件POST /open-apis/approval/v4/:approval_code/subscribe | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token | ||
取消订阅审批事件POST /open-apis/approval/v4/:approval_code/unsubscribe | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token |
资源:审批实例 Instance
方法列表
方法 (API) | 权限要求 | 访问凭证 | ||
---|---|---|---|---|
创建审批实例POST /open-apis/approval/v4/instances | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token | ||
批量获取审批实例IDGET /open-apis/approval/v4/instances | 访问审批应用 | tenant_access_token | ||
获取单个审批实例详情GET /open-apis/approval/v4/instances/:instance_id | 访问审批应用 | tenant_access_token | ||
审批实例抄送POST /open-apis/approval/v4/instances/cc | 访问审批应用 | tenant_access_token | ||
审批实例撤回POST /open-apis/approval/v4/instances/cancel | 访问审批应用 | tenant_access_token | ||
审批流程预览POST /open-apis/approval/v4/instances/preview | 访问审批应用 | tenant_access_token |
事件列表
事件(event) | 权限要求 | 触发时机 | ||
---|---|---|---|---|
审批定义更新 | 访问审批应用 | 审批定义变更 | ||
审批实例更新 | 访问审批应用 | 审批实例状态变更 | ||
审批任务更新 | 访问审批应用 | 审批任务状态变更 | ||
请假审批 | 访问审批应用 | 「审批」应用的表单里如果包含 请假控件组,则在此表单审批通过后触发此事件 | ||
加班审批 | 访问审批应用 | 「审批」应用的表单里如果包含 加班控件组,则在此表单审批通过后触发此事件 | ||
换班审批 | 访问审批应用 | 「审批」应用的表单包含换班控件组的,换班申请审批通过后触发此事件 | ||
补卡审批 | 访问审批应用 | 补卡申请审批通过后触发此事件。 你可以在「打卡」应用里提交补卡申请 | ||
出差审批 | 访问审批应用 | 「审批」应用的表单里如果包含 出差控件组,则在此表单审批通过后触发此事件 | ||
外出审批事件 | 访问审批应用 | 「审批」应用的表单里如果包含 外出控件组,则在此表单审批通过后触发此事件 |
资源:审批任务 Task
方法列表
方法 (API) | 权限要求 | 访问凭证 | ||
---|---|---|---|---|
审批任务同意POST /open-apis/approval/v4/tasks/approve | 访问审批应用 | tenant_access_token | ||
审批任务拒绝POST /open-apis/approval/v4/tasks/reject | 访问审批应用 | tenant_access_token | ||
审批任务转交POST /open-apis/approval/v4/tasks/transfer | 访问审批应用 | tenant_access_token | ||
审批任务退回POST /open-apis/approval/v4/tasks/specified_rollback | 访问审批应用 | tenant_access_token | ||
审批任务加签POST /open-apis/approval/v4/tasks/add_sign | 访问审批应用 | tenant_access_token |
资源:审批评论 Comment
方法列表
方法 (API) | 权限要求 | 访问凭证 | ||
---|---|---|---|---|
创建评论POST /open-apis/approval/v4/instances/:instance_id/comments | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token | ||
获取评论GET /open-apis/approval/v4/instances/:instance_id/comments | 查看、创建、更新、删除审批应用相关信息Access Approval | tenant_access_token | ||
删除评论DELETE /open-apis/approval/v4/instances/:instance_id/comments/:comment_id | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token | ||
清空评论POST /open-apis/approval/v4/instances/:instance_id/comments/remove | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token |
资源:三方审批定义 External Approval
方法列表
方法 (API) | 权限要求 | 访问凭证 | ||
---|---|---|---|---|
三方审批定义创建POST /open-apis/approval/v4/external_approvals | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token |
资源:三方审批实例 External Instance
方法列表
方法 (API) | 权限要求 | 访问凭证 | ||
---|---|---|---|---|
三方审批实例同步POST /open-apis/approval/v4/external_instances | 查看、创建、更新、删除审批应用相关信息 | tenant_access_token | ||
三方审批实例校验POST /open-apis/approval/v4/external_instances/check | 访问审批应用 | tenant_access_token |