简介
教学内容
本教程介绍开发者如何将本地文件上传到钉钉文档(我的文档)目录中。
教学目标
帮助开发者快速掌握本地文件上传至钉钉文档(我的文档)目录中的能力。教学范围
面向钉钉所有开发者前提条件
- 已经获取开发者权限。
- 已经安装了 IDE 或其他开发工具。
- 已经安装了 node.js,并完成了相关环境的配置。
- 已经安装了 maven,并完成了相关环境的配置。
- 已经安装了 JDK,并完成了相关环境的配置。
开发流程
-
调用获取我的文档知识库信息接口,获取“我的文档”根节点 ID,即返回参数
rootNodeId(parentDentryUuid)。 -
调用获取文件上传信息接口,获取上传文件所需的
resourceUrls和headers参数值。 -
使用 OSS 的 header 加签方式上传文件:
Java
PythonC#PHPNode.js
- 调用提交文件接口,上传文件到钉钉文档(我的文档)目录中。
步骤一:创建应用
- 登录开发者后台。
- 单击应用开发 > 企业内部应用 > 钉钉应用 > 创建应用。
-
填写应用信息。
配置项 是否必选 配置说明 应用名称 是 输入应用名称,应用名称最小长度为 2 个字符。 应用描述 是 简要描述应用提供的产品或服务,应用描述最小长度为 4 个字符。 应用图标 否 上传应用图标,图标要求 JPG/PNG 格式、240 px * 240 px 以上、1:1 、2 MB 以内的无圆角图标。 - 单击保存,进入应用详情页。
注意:保存 Client ID 和 Client Secret,后续需要使用。
步骤二:配置网页应用
- 在应用详情页,单击应用能力 > 添加应用能力。
- 选择添加网页应用。
-
配置网页应用(H5)信息:
配置完成后,单击保存。
配置项 说明 应用首页地址 填写首页地址,本示例使用: http://localhost:5173?corpid=$CORPID$用于后续测试。 本示例仅用于本地测试。 imagePC端首页地址
步骤三:申请接口权限
- 在应用详情页,单击开发配置 > 权限管理,进入权限申请页面。
-
在权限搜索框中分别输入
Wiki.Workspace.Read、Storage.UploadInfo.Read和Storage.File.Write,并申请接口权限。如果你不是企业管理员/没有应用开发权限,申请权限时需要企业管理员审批。
步骤四:发布应用
- 应用配置完成后,你需要发布应用,在应用详情页,单击应用发布 > 版本管理与发布。
- 单击创建新版本,进入版本详情页面。
-
配置版本信息:
配置完成后,单击下方保存。
配置项 说明 应用版本号 填写应用版本号,使用默认版本即可。 版本描述 填写版本描述信息,自定义即可。 待发布内容 工作台显示的应用能力: - 选择网页应用 -
在保存成功的弹框页面,单击直接发布。
如果你不是企业管理员,发布应用时需要企业管理员审批,发布仅我可见则无需管理员审批。
步骤五:构建服务
- 确保已经完成上述步骤,获取下方 Demo 运行的参数信息。
- 你可以下载 doc-demo.zip Demo。
-
打开 IDE,并导入已下载的 Demo。
示例代码分为 backend(后端代码目录)和frontend(前端代码目录)。
-
打开后端代码目录,在 resources 目录中修改
application.properties文件,填写clientId(应用Client ID)、clientSecret(应用Client Secret)。
-
点击启动后端服务。
说明
- 在启动后端服务前,请确保已经正确安装Maven 和 JDK,并配置了相关环境;如果是初次安装 IDE,需要在 IDE 中修改相关配置文件。
- 确保 5173 和 8080 端口没有被占用。
-
打开前端代码目录,修改
vite.config.ts,并填写正确的clientId(应用Client ID)。
-
点击前端项目文件,鼠标右键并选择终端打开。
-
在终端窗口中,输出以下命令:
-
npm install -
npm run dev注意:windows 在启动时候,请使用
npm run dev:raw。
-
- 至此,前端和后端服务已经启动成功。
步骤六:测试应用
-
登录钉钉客户端,选择应用所在的组织。
-
单击工作台 > 添加,搜索上方你创建的企业应用并完成添加操作。
-
在工作台访问应用,并单击选择本地文件上传。
要求上传文件小于 50M。
-
选择文件后,单击提交,完成上传操作。
-
上传完成后,即可打开文件查看上传内容。