《钉钉应用开发者速成手册》之“API实战——搭建审批工作流”

本文涉及的产品
.cn 域名,1个 12个月
简介: 本教程以一个简单的出差审批工作流为例展示如何发起一个审批。为了方便开发者体验,我们提供了服务端和前端代码,您只需要根据本文档的操作,完成基础配置既可。

准备工作

在开始接入前,确保您已经完成以下准备工作:

  • 安装小程序IDE,单击小程序开发工具下载。
  • 已下载并安装了IntelliJ IDEA开发工具。若未安装,请访问IntelliJ IDEA
  • 已经安装了Java开发环境。若未安装,请访问Oracle官网下载。
  • 已经安装了Java项目构建工具Maven。若未安装,请访问Apache Maven下载。
  • 已经安装了项目管理工具Git。若未安装,请访问Git官网下载。

创建应用

在本部分,你将在开发者后台创建一个H5微应用,并完成基础配置。

  1. 登录钉钉开发者后台

    说明
    只有管理员和子管理员可登录开发者后台。
  2. 开发者后台页面,单击应用开发,然后选择企业内部开发 > 小程序,最后单击创建应用
    image.png
  3. 在弹出的创建应用页面中填写基本信息,然后单击确定创建
  • 应用类型:选择小程序
  • 开发方式:选择企业自助开发

image.png

  1. 应用创建完成后,在凭证与基础信息页面,复制应用的AppKeyAppSecretAgentId备用。
    image.png
  2. 单击开发管理进入开发管理页面,然后单击修改,并根据以下内容配置开发信息。
  • 服务器出口IP:输入调用钉钉服务端API时使用的IP即企业服务器的公网IP,多个IP请以英文逗号","隔开,支持带一个*号通配符的IP格式。可通过工具进行查看。
    本教程设置为127.0.0.1
  • PC端首页地址(可选):输入在PC端钉钉工作台上打开本应用的地址。链接地址必须以http或https开头。
    本教程设置为:https://ding-doc.dingtalk.com/
  • 管理后台地址(可选):输入组织管理员在钉钉管理后台访问该应用的地址。

image.png

  1. 单击人员管理,然后单击添加人员添加开发人员。

    说明
    应用创建后,默认开发人员为应用创建者。
    image.png
  2. 单击安全中心,然后单击添加添加一个HTTP安全域名。
    当小程序的前端与服务端需要进行网络通信时,需要设置安全域名。小程序前端只能通过已设置的安全域名(或IP)与服务端进行网络通信。当安全域名更新时,需要在小程序开发工具重新打包上传版本,设置的域名才会生效。
    安全域名是后端服务部署的服务器的公网IP或域名,本教程输入127.0.0.1
    image.png
  3. 单击权限管理进入权限管理页面,然后根据以下配置添加接口调用权限。
  1. 权限范围选择全部员工,然后单击添加接口权限
  2. 选择通讯录审批接口权限

image.png

创建出差申请表单

在本部分,你将在OA管理后台创建审批模板。

  1. 使用管理员账号登录OA管理后台,然后选择工作台 > OA审批
    image.png
  2. 表单管理页面,单击创建新表单,然后选择自定义流程表单
    image.png
  3. 基础配置页面,完成基础信息配置。
    image.png
  4. 单击表单设计,然后在控件库中根据下表设计出差申请表单,并保存url中的processCode。

    说明
    拖拽控件后,需要修改控件标题。

表单项

使用控件

行程明细

明细/表格控件

出差地点

单行输入框控件

图片

图片控件

开始时间,结束时间

日期区间控件

出差人数

数字控件

出差金额

金额控件

出差同伴

单选框控件(添加的时候,把选项改为A,B,C)

交通工具

单行输入框控件

出差事由

多行输入框控件

image.png
   注意
   切记保存好processCode,在服务端开发时需要该参数。

  1. 单击流程设计,单击+设置审批条件和审批人,如下图所示。
    image.png
  2. 流程设计完成后,单击发布完成表单设计。

服务端开发

在本部分你将下载服务端代码,并完成基础配置。

参考以下操作,完成服务端开发:

  1. 执行以下代码,下载服务端代码。
git clone https://github.com/opendingtalk/eapp-corp-project.git
  1. 使用IntelliJ IDEA打开下载的代码工程,并修改配置:
  1. 运行IntelliJ IDEA,然后在启动页面单击Open
    image.png
  2. 选择刚刚下载的服务端代码,然后单击OK
    image.png
  3. 打开src/main/java/com/config/Constant.java文件,修改以下信息。
/**
 * 企业corpid, 需要修改成开发者所在企业
 */
public static final String CORP_ID = "***";
/**
 * 应用的AppKey,登录开发者后台,点击应用管理,进入应用详情可见
 */
public static final String APPKEY = "***";
/**
 * 应用的AppSecret,登录开发者后台,点击应用管理,进入应用详情可见
 */
public static final String APPSECRET = "***";
/**
 * 数据加密密钥。用于回调数据的加密,长度固定为43个字符,从a-z, A-Z, 0-9共62个字符中选取,您可以随机生成
 */
public static final String ENCODING_AES_KEY = "***";
/**
 * 加解密需要用到的token,企业可以随机填写。如 "12345"
 */
public static final String TOKEN = "***";
/**
 * 应用的agentdId,登录开发者后台可查看
 */
public static final Long AGENTID = 111L;
/**
 * 审批模板唯一标识,可以在审批管理后台找到
 */
public static final String PROCESS_CODE = "***";
  1. 参考以下操作,部署后端服务。
  1. 打开src/main/java/com/Application.java文件。
  2. 使用快捷键ctrl+shift+f10,运行后端服务。
  1. 服务端启动后,在浏览器中访问http://localhost:8080/welcome,打开如下页面表示启动成功。
    image.png

开发小程序

在本部分你将下载前端代码,并完成基础配置。

参考以下操作,完成前端开发:

  1. 执行以下命令,下载前端代码。
git clone https://github.com/opendingtalk/eapp-corp-project-fe
  1. 打开小程序IDE开发工具,打开已下载的项目。

    说明
    项目类型选择钉钉企业内部应用
    image.png
  2. 关联步骤一中创建的小程序应用。
    image.png
  3. 打开eapp-corp-project-fe/page/index/index.js文件修改服务端URL,URL中的IP或者域名必须是开发者后台中设置的本应用的安全域名。小程序前端发起网络请求时是直连安全域名或IP的。
    本示例中设置为http://127.0.0.1:8080
    image.png
  4. 单击发起审批即可发起一个审批实例。
    为了保持代码的简洁,本次demo发起的审批实例中,审批发起人、审批人和抄送人是同一个用户,即当前免登的用户。image.png
  5. 打开钉钉打开移动端或PC端钉钉,找到该企业工作通知,查看收到的审批通知。
    image.png

恭喜

你已完成本教程的全部内容!

现在你已经拥有一个可以正常运行的钉钉小程序。你也可以在其中添加其他功能,参考应用开发了解更多。

你还还可以通过以下方式注册审批事件。

  • 注册回调你可以通过以下方法注册或更新企业的回调地址:
  1. 打开已下载的服务端代码,修改服务端代码Constant.java文件中的CALLBACK_URL_HOST参数,设置成你的回调地址
  2. 运行CallbackController中的main方法,注册或更新企业的回调地址。
  3. 当控制台打印出回调注册成功了!!!时,表示注册回调成功。
  • 接收审批回调
    注册完审批回调,当审批被通过或拒绝时,服务端会接收到对应的回调通知,您可以结合您的业务场景做相应的处理。

在本示例中,服务端接收回调后,会给审批发起人发一条工作通知消息。

image.png

相关文章
|
14天前
|
程序员 API 开发者
实战阿里qwen2.5-coder 32B,如何配置Cline的Ollama API接口。
阿里Qwen2.5大模型开源免费,适合编程应用。在Ollama平台下载时,推荐选择带有“cline”字样的Qwen2.5-Coder版本,仅需额外下载适配文件,无需重复下载模型文件。Ollama环境永久免费,配置简单,效果出色,适合开发者使用。
706 77
|
7天前
|
供应链 搜索推荐 API
深度解析1688 API对电商的影响与实战应用
在全球电子商务迅猛发展的背景下,1688作为知名的B2B电商平台,为中小企业提供商品批发、分销、供应链管理等一站式服务,并通过开放的API接口,为开发者和电商企业提供数据资源和功能支持。本文将深入解析1688 API的功能(如商品搜索、详情、订单管理等)、应用场景(如商品展示、搜索优化、交易管理和用户行为分析)、收益分析(如流量增长、销售提升、库存优化和成本降低)及实际案例,帮助电商从业者提升运营效率和商业收益。
73 17
|
1天前
|
XML API 开发者
探究获取亚马逊畅销榜API接口及实战应用
亚马逊MWS(商城网络服务)提供了一系列API接口,帮助开发者获取平台数据,其中畅销榜API尤为关键。通过注册开发者账号、创建应用并申请权限,可使用HTTP POST请求获取商品的销售排名、价格等信息。Python代码示例展示了如何构建和发送请求,并处理返回的XML或JSON数据。注意遵守亚马逊的频率限制、数据准确性和合规性要求,以确保安全合法地利用这些数据支持电商业务决策。
9 1
|
2天前
|
JSON 监控 API
获取1688商品SKU信息API接口及实战应用
在电商蓬勃发展的今天,数据成为宝贵的财富。1688作为国内知名批发采购平台,提供商品SKU信息API接口,可获取库存、价格、规格等关键数据,助力电商运营、市场分析和价格监控。本文介绍如何注册1688开放平台账号、创建应用并获取AppKey/AppSecret,申请API权限,使用Python实现接口调用,处理响应数据,并注意请求频率限制和错误处理。通过该接口,可为电商运营和数据分析提供有力支持。
17 2
|
4天前
|
安全 程序员 API
API对于程序员的多元用法:从基础到实战
API(应用程序编程接口)是现代软件开发中不可或缺的工具,充当不同系统间沟通的桥梁。通过API,程序员可以轻松获取外部数据、扩展应用功能、实现微服务间的通信等,极大提升开发效率和应用功能性。常见的API类型包括Web API、本地API和第三方API。使用API,开发者能快速集成复杂功能(如支付、物流跟踪),并确保数据安全与管理。掌握API的开发、维护及安全管理技巧,对构建高效、稳定的应用至关重要。随着数字化进程加速,API的重要性将不断提升。
15 1
|
23天前
|
安全 API 数据安全/隐私保护
速卖通AliExpress商品详情API接口深度解析与实战应用
速卖通(AliExpress)作为全球化电商的重要平台,提供了丰富的商品资源和便捷的购物体验。为了提升用户体验和优化商品管理,速卖通开放了API接口,其中商品详情API尤为关键。本文介绍如何获取API密钥、调用商品详情API接口,并处理API响应数据,帮助开发者和商家高效利用这些工具。通过合理规划API调用策略和确保合法合规使用,开发者可以更好地获取商品信息,优化管理和营销策略。
|
1月前
|
人工智能 API 语音技术
开发者福利,魔搭推出免费模型推理API,注册就送每日2000次调用!
今天,魔搭社区开放了免费的开源模型推理API,仅需使用魔搭的SDK Token,就可以通过简单的API请求探索各种强大的开源模型的使用。
|
2月前
|
JSON BI API
商城上货API接口的实战案例
在商城上货过程中,API接口扮演着至关重要的角色。以下是对商城上货API接口的实战分析,涵盖其主要功能、类型、安全性以及实战案例等方面。
|
2月前
|
XML 数据可视化 API
商品详情数据实战案例,API接口系列
淘宝商品详情数据在电商领域具有广泛的应用价值,而淘宝商品详情API接口则为开发者提供了获取这些数据的重要途径。通过合理利用这些接口和数据,可以提升业务效率、优化用户体验,为电商行业的发展注入新的活力。
|
2月前
|
前端开发 API 开发者
Python Web开发者必看!AJAX、Fetch API实战技巧,让前后端交互如丝般顺滑!
在Web开发中,前后端的高效交互是提升用户体验的关键。本文通过一个基于Flask框架的博客系统实战案例,详细介绍了如何使用AJAX和Fetch API实现不刷新页面查看评论的功能。从后端路由设置到前端请求处理,全面展示了这两种技术的应用技巧,帮助Python Web开发者提升项目质量和开发效率。
68 1

热门文章

最新文章