《钉钉应用开发者速成手册》之“如何调用钉钉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月前
|
人工智能 数据可视化 API
10 分钟构建 AI 客服并应用到网站、钉钉或微信中测试评
10 分钟构建 AI 客服并应用到网站、钉钉或微信中测试评
145 2
|
5月前
|
人工智能
10 分钟构建 AI 客服并应用到网站、钉钉或微信中简说
10 分钟构建 AI 客服并应用到网站、钉钉或微信
|
3月前
|
Java API 开发工具
API参考手册
【10月更文挑战第18天】API参考手册
86 2
|
4月前
|
人工智能 运维 负载均衡
10 分钟构建 AI 客服并应用到网站、钉钉或微信中
《10分钟构建AI客服并应用到网站、钉钉或微信中》的解决方案通过详尽的文档和示例代码,使具有一定编程基础的用户能够快速上手,顺利完成AI客服集成。方案涵盖高可用性、负载均衡及定制化选项,满足生产环境需求。然而,若文档不清晰或存在信息缺失,则可能导致部署障碍。实际部署中可能遇到网络、权限等问题,需逐一排查。云产品的功能、性能及操作配置便捷性直接影响解决方案效果,详尽的产品手册有助于快速解决问题。总体而言,该方案在各方面表现出色,值得推荐。
|
4月前
|
小程序 Android开发 iOS开发
ISO钉钉小程序小程序webview打开nextjs应用异常
ISO钉钉小程序小程序webview打开nextjs应用异常
72 3
|
7月前
|
jenkins 机器人 测试技术
jenkins接入钉钉api接口自动化测试报告自动发送
该教程介绍了如何在Jenkins上实现接口自动化测试的持续集成,并将可视化报告发送至钉钉工作群。首先,确保准备好了自动化脚本。接着配置Jenkins:安装Git插件,设置源代码管理(如Git)和触发器(定时或推送)。使用Post build task插件处理构建后的报告,读取Allure的prometheusData.txt文件以获取测试结果。最后,安装Ding Talk插件,配置钉钉机器人,通过 Dingtalkchatbot 库发送测试报告信息到钉钉群。整个流程包括Jenkins的定时构建、Git仓库的监听以及自动化报告发送到钉钉的通知。
|
7月前
|
移动开发 文字识别 算法
视觉智能开放平台产品使用合集之如何集成到使用钉钉端的H5应用中
视觉智能开放平台是指提供一系列基于视觉识别技术的API和服务的平台,这些服务通常包括图像识别、人脸识别、物体检测、文字识别、场景理解等。企业或开发者可以通过调用这些API,快速将视觉智能功能集成到自己的应用或服务中,而无需从零开始研发相关算法和技术。以下是一些常见的视觉智能开放平台产品及其应用场景的概览。
|
8月前
|
API
请问下钉钉有能够获取到群聊天和个人聊天历史记录的api嘛?
DingTalk API 文档中的“消息列表创建”链接似乎已失效:https://developers.dingtalk.com/document/app/message-list-creation. 请注意检查更新或寻找替代资源。
|
8月前
|
API
钉钉API调试工具使用
钉钉API调试工具使用
226 0
|
8月前
|
Serverless Go API
Serverless 应用引擎产品使用之在阿里云Serverless中,我想在钉钉机器人中使用函数计算的签名认证如何解决
阿里云Serverless 应用引擎(SAE)提供了完整的微服务应用生命周期管理能力,包括应用部署、服务治理、开发运维、资源管理等功能,并通过扩展功能支持多环境管理、API Gateway、事件驱动等高级应用场景,帮助企业快速构建、部署、运维和扩展微服务架构,实现Serverless化的应用部署与运维模式。以下是对SAE产品使用合集的概述,包括应用管理、服务治理、开发运维、资源管理等方面。

热门文章

最新文章