《钉钉应用开发者速成手册》之“如何调用钉钉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
Eolink神技之三、钉钉API对接
Eolink神技之三、钉钉API对接
68 0
|
4天前
|
API
钉钉API调试工具使用
钉钉API调试工具使用
27 0
|
4天前
|
API
请问下钉钉有能够获取到群聊天和个人聊天历史记录的api嘛?
DingTalk API 文档中的“消息列表创建”链接似乎已失效:https://developers.dingtalk.com/document/app/message-list-creation. 请注意检查更新或寻找替代资源。
|
4天前
|
Serverless Go API
Serverless 应用引擎产品使用之在阿里云Serverless中,我想在钉钉机器人中使用函数计算的签名认证如何解决
阿里云Serverless 应用引擎(SAE)提供了完整的微服务应用生命周期管理能力,包括应用部署、服务治理、开发运维、资源管理等功能,并通过扩展功能支持多环境管理、API Gateway、事件驱动等高级应用场景,帮助企业快速构建、部署、运维和扩展微服务架构,实现Serverless化的应用部署与运维模式。以下是对SAE产品使用合集的概述,包括应用管理、服务治理、开发运维、资源管理等方面。
21 0
|
4天前
|
移动开发
钉钉PC端点击消息通知的链接显示该应用已停用或未授权你的访问
开发的H5微应用能发送含详情页链接的卡片消息至用户移动端,用户可顺利跳转。然而,在PC端点击相同链接会显示“应用已停用或未授权”,提示联系管理员,附带图片说明问题。
|
4天前
|
监控 Serverless 开发者
Serverless 应用引擎常见问题之应用重启或者挂了通过钉钉发消息提醒如何解决
Serverless 应用引擎(Serverless Application Engine, SAE)是一种完全托管的应用平台,它允许开发者无需管理服务器即可构建和部署应用。以下是Serverless 应用引擎使用过程中的一些常见问题及其答案的汇总:
30 1
|
4天前
钉钉开放平台支持多种类型的应用
【2月更文挑战第19天】钉钉开放平台支持多种类型的应用
36 6
|
4天前
|
前端开发 BI API
钉钉多维表目前没有提供具体的API文档供开发者调用
【2月更文挑战第17天】钉钉多维表目前没有提供具体的API文档供开发者调用
55 4
|
运维 API 开发者
玩 High API 系列之:实现钉钉Ding功能
钉钉是企业IM市场上的领先者,深受中小企业客户的喜欢,就再几天前刚刚宣布用户数超过1亿!在钉钉里面有个特别实用的功能,那就是Ding一下,如果你发的消息特别紧急,可以直接通过短信、电话等方式直接通知到接收人的手机上。
玩 High API 系列之:实现钉钉Ding功能
|
2天前
|
监控 安全 数据挖掘
Email 接口API有哪些?具体分析一下阿里云和AOK的优点
本文介绍了常见的Email接口API,如阿里云邮件推送、AOKSend、SendGrid、Mailgun和Amazon SES。阿里云API以其高稳定性和数据分析功能脱颖而出,支持批量发送和多语言;而AOKSend API以易于集成、高安全性和优秀客户支持为亮点。企业在选择时应考虑自身需求和预算,以优化邮件营销效果。

热门文章

最新文章