《钉钉应用开发者速成手册》之“如何调用钉钉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

相关文章
|
6月前
|
开发框架 .NET API
RESTful API 设计与实现:C# 开发者的一分钟入门
【10月更文挑战第5天】本文从零开始,介绍了如何使用 C# 和 ASP.NET Core 设计并实现一个简单的 RESTful API。首先解释了 RESTful API 的概念及其核心原则,然后详细说明了设计 RESTful API 的关键步骤,包括资源识别、URI 设计、HTTP 方法选择、状态码使用和错误处理。最后,通过一个用户管理 API 的示例,演示了如何创建项目、定义模型、实现控制器及运行测试,帮助读者掌握 RESTful API 的开发技巧。
208 7
|
1月前
|
API
钉钉宜搭--远程API,在其他人访问时无法生效
简介: 描述了一种远程API配置问题的场景。开发人员在本地可正常通过应用表单获取数据,但同组织的其他同事访问时无法获取数据,尽管已设置全部权限。问题是关于如何解决这种跨用户数据访问异常的情况,确保同事间能正常共享数据。
|
7月前
|
人工智能 数据可视化 API
10 分钟构建 AI 客服并应用到网站、钉钉或微信中测试评
10 分钟构建 AI 客服并应用到网站、钉钉或微信中测试评
221 2
|
8月前
|
人工智能
10 分钟构建 AI 客服并应用到网站、钉钉或微信中简说
10 分钟构建 AI 客服并应用到网站、钉钉或微信
|
8月前
|
安全 Java API
告别繁琐编码,拥抱Java 8新特性:Stream API与Optional类助你高效编程,成就卓越开发者!
【8月更文挑战第29天】Java 8为开发者引入了多项新特性,其中Stream API和Optional类尤其值得关注。Stream API对集合操作进行了高级抽象,支持声明式的数据处理,避免了显式循环代码的编写;而Optional类则作为非空值的容器,有效减少了空指针异常的风险。通过几个实战示例,我们展示了如何利用Stream API进行过滤与转换操作,以及如何借助Optional类安全地处理可能为null的数据,从而使代码更加简洁和健壮。
219 0
|
4月前
|
人工智能 API 语音技术
开发者福利,魔搭推出免费模型推理API,注册就送每日2000次调用!
今天,魔搭社区开放了免费的开源模型推理API,仅需使用魔搭的SDK Token,就可以通过简单的API请求探索各种强大的开源模型的使用。
296 9
|
6月前
|
Java API 开发工具
API参考手册
【10月更文挑战第18天】API参考手册
177 2
|
7月前
|
人工智能 运维 负载均衡
10 分钟构建 AI 客服并应用到网站、钉钉或微信中
《10分钟构建AI客服并应用到网站、钉钉或微信中》的解决方案通过详尽的文档和示例代码,使具有一定编程基础的用户能够快速上手,顺利完成AI客服集成。方案涵盖高可用性、负载均衡及定制化选项,满足生产环境需求。然而,若文档不清晰或存在信息缺失,则可能导致部署障碍。实际部署中可能遇到网络、权限等问题,需逐一排查。云产品的功能、性能及操作配置便捷性直接影响解决方案效果,详尽的产品手册有助于快速解决问题。总体而言,该方案在各方面表现出色,值得推荐。
|
6月前
|
存储 安全 API
12种最基本Web API:开发者的必学清单⭐
这些Web API 为创建高度互动和用户友好的网页应用开辟了无限可能。从存储和支付到地理位置和图形,掌握这些 API 可以提升您的Web开发技能。
315 2
|
6月前
|
前端开发 API 开发者
深度剖析:AJAX、Fetch API如何成为Python后端开发者的最佳拍档!
深度剖析:AJAX、Fetch API如何成为Python后端开发者的最佳拍档!
71 4