《钉钉应用开发者速成手册》之“如何调用钉钉API——使用API Explorer”

简介: API Explorer是钉钉开放平台提供的可视化服务端API调用工具,方便开发者在线发起API调用。本文将以API Explorer工具发起一个待办事项为例,帮助您快速了解API Explorer工具的使用。

步骤一:创建应用

  1. 使用钉钉开发者账号登录开发者后台,在企业内部下,选择小程序,然后单击创建应用
    image.png
  2. 填写应用名称、应用描述,选择应用图标,最后单击确定创建
    image.png

应用创建完成后,在凭证与基础信息页面,复制应用的AgentIdAppKeyAppSecret备用。
image.png

  1. 选择开发管理,单击修改,完成以下配置:
  • 服务器出口IP:输入调用钉钉服务端API时使用的IP即企业服务器的公网IP,多个IP请以","隔开,支持带一个*号通配符的IP格式。

    说明
    服务器出口IP需要填写开发者自己的公网出口IP,可通过工具进行查看。
  • PC端首页地址(可选):输入在PC端钉钉工作台上打开本应用的地址。链接地址必须以http或https开头。

    说明
    如果未填写,在钉钉PC端工作台点击应用图标时,会提示“电脑版暂不支持显示,请用手机钉钉扫描下方二维码查看”。只能在手机钉钉客户端使用该应用。
  • 管理后台地址(可选):输入组织管理员在钉钉管理后台访问该应用的地址。

image.png

  1. 选择权限管理,然后单击添加接口权限,
    image.png
  2. 选择待办事项的接口权限,最后单击确认。
    image.png

步骤二:发起待办

通过以下步骤,使用API Explorer工具完成发起待办:

  1. 在开发者后台的首页打开API Explorer
    image.png
  2. 获取企业凭证access_token。通过调用/gettoken接口获取企业凭证access_token,获取步骤如下:
  1. 选择应用类型为企业内部应用
  • 企业内部应用:当前API接口仅限于企业内部调用。
  • 第三方企业应用:当前API接口仅限于第三方企业调用。
    image.png
  1. 依次选择左侧获取凭证,然后选择获取企业凭证
    image.png
  2. 填写appkey和appsecret,然后单击发起调用
  • appkey:已创建应用的AppKey。
  • appsecret:已创建应用的AppSecret。

    说明
    API Explorer右侧会直接生成对应的接口demo,可以选择SDK下载,也可以选择查看文档,和官网文档一模一样。右侧显示调用结果成功之后,请复制返回结果access_token的值,用于后续的使用。
    image.png
  1. 获取用户userId。通过调用/user/listsimple接口获取用户userId,获取步骤如下:
  1. 单击左侧通讯录管理,然后选择查询部门用户简易信息接口。

    说明
    支持中英文模糊搜索。
    image.png
  2. 填写相关参数信息,然后单击发起调用
  • access_token:已生成的access_token。
  • dept_id:部门ID,根部门ID为1。
  • cursor:分页查询的游标,最开始传0。
  • size:分页长度。

    说明
    右侧显示调用结果成功之后,请复制返回结果中对应用户的userid的值,用于后续的使用。
    image.png
  1. 点击左侧的待办任务模块,选择新增待办事项,填写待办事项内容,单击发起调用
  • access_token:已获取的access_token。
  • userId:已获取的userId。
  • create_time:待办时间。
  • title:待办事项的标题。
  • url:待办事项的跳转链接。
  • formItemList:表单列表。
  • title:表单标题。
  • content:表单内容。

image.png

调用成功后,在待办中会显示对应的待办任务,如下图所示:

image.png

相关文章
|
4月前
|
JSON API 数据格式
小红书API接口文档:笔记详情数据开发手册
小红书笔记详情API可获取指定笔记的标题、正文、互动数据及多媒体资源,支持字段筛选与评论加载。通过note_id和access_token发起GET/POST请求,配合签名验证,广泛用于内容分析与营销优化。
|
4月前
|
供应链 搜索推荐 数据挖掘
探秘京东 API 接口的神奇应用场景
京东API如同数字钥匙,助力商家实现商品、库存、订单等多平台高效同步,提升效率超80%。支持物流实时追踪,增强用户满意度;赋能精准营销与数据分析,决策准确率提升20%以上,全面优化电商运营。
157 1
|
5月前
|
人工智能 自然语言处理 机器人
使用 API 编程开发扣子应用
扣子(Coze)应用支持通过 API 编程,将 AI 聊天、内容生成、工作流自动化等功能集成至自有系统。主要 API 包括 Bot API(用于消息交互与会话管理)及插件与知识库 API(扩展功能与数据管理)。开发流程包括创建应用、获取密钥、调用 API 并处理响应,支持 Python 等语言。建议加强错误处理、密钥安全与会话管理,提升集成灵活性与应用扩展性。
1658 0
|
6月前
|
监控 供应链 搜索推荐
电商数据开发实践:深度剖析1688商品详情 API 的技术与应用
在电商数字化转型中,数据获取效率与准确性至关重要。本文介绍了一款高效商品详情API,具备全维度数据采集、价格库存管理、多媒体资源获取等功能,结合实际案例探讨其在电商开发中的应用价值与优势。
|
6月前
|
API 定位技术 调度
实现精准定位的—坐标系经纬度转换API技术说明和行业应用
在地图服务、物流调度等应用中,多源地理位置数据因采用不同坐标系(如WGS84、GCJ02、BD09)需统一转换,以避免位置偏移影响路径规划与分析精度。本文介绍坐标转换背景、技术方案及Python调用示例,强调其在智慧交通与物流系统中的重要性。
673 0
|
4月前
|
Ubuntu API C++
C++标准库、Windows API及Ubuntu API的综合应用
总之,C++标准库、Windows API和Ubuntu API的综合应用是一项挑战性较大的任务,需要开发者具备跨平台编程的深入知识和丰富经验。通过合理的架构设计和有效的工具选择,可以在不同的操作系统平台上高效地开发和部署应用程序。
214 11
|
5月前
|
人工智能 数据可视化 测试技术
AI 时代 API 自动化测试实战:Postman 断言的核心技巧与实战应用
AI 时代 API 自动化测试实战:Postman 断言的核心技巧与实战应用
724 11
|
5月前
|
NoSQL API 双11
淘宝订单 API 实战:90% 开发者会踩的 “漏单坑”,我用这 3 招彻底解决
本文深入解析了淘宝订单 API 对接中常见的“漏单”问题,结合实战案例拆解了同步逻辑、漏单原因及解决方案。重点分析了“主动轮询”与“回调通知”两种方式的优缺点,指出高频漏单的三大原因:回调丢包、时间窗口设置错误、订单状态判断不全,并提供对应的解决策略。最后分享了一套“回调 + 轮询”双保险方案,帮助彻底杜绝漏单问题。
|
5月前
|
安全 API 数据安全/隐私保护
【Azure 环境】Microsoft Graph API实现对Entra ID中应用生成密码的时间天数
本文介绍如何通过 Azure 的 App Management Policy 限制用户在创建 AAD 应用程序的 Client Secret 时设置最长 90 天的有效期。通过 Microsoft Graph API 配置 defaultAppManagementPolicy,可有效控制密码凭据的生命周期,增强安全管理。
167 4
|
5月前
|
Java API 开发者
揭秘淘宝详情 API 接口:解锁电商数据应用新玩法
淘宝详情API是获取商品信息的“金钥匙”,可实时抓取标题、价格、库存等数据,广泛应用于电商分析、比价网站与智能选品。合法调用,助力精准营销与决策,推动电商高效发展。(238字)
199 0