钉钉

integrated-development

# 一、钉钉SDK

# 服务端Maven依赖

新版服务端SDK-MAVEN依赖:

<dependency>
 <groupId>com.aliyun</groupId>
 <artifactId>dingtalk</artifactId>
 <version>{sdk-version}</version>
</dependency>
1
2
3
4
5

最新的SDK版本可以在这里 (opens new window)查看。

开发者请选择使用SDK最新版本。截止2023年1月30日,最新版本为1.5.31。

旧版服务端SDK-MAVEN依赖:

<dependency>
 <groupId>com.aliyun</groupId>
 <artifactId>alibaba-dingtalk-service-sdk</artifactId>
 <version>2.0.0</version>
</dependency>
1
2
3
4
5

# 服务端SDK下载 (opens new window)

新版服务端SDK-JAVA SDK下载地址:https://open-dev.dingtalk.com/sdk/download/java (opens new window)

旧版服务端SDK-JAVA SDK下载地址:点击下载 (opens new window)

# 服务端API总览 (opens new window)

钉钉提供的服务端API总览。

新旧版规范服务端API区别 (opens new window)

调用新版服务端API (opens new window)

# API调用量和频次限制 (opens new window)

  1. 调用频次:标准版钉钉组织,企业内部应用、委托第三方定制开发企业内部应用,每个应用调用服务端接口每秒并发的最高频次限制为20qps;当超过限制时,调用对应接口时将返回对应错误码,错误码详情请查看附录B:如何处理钉钉服务端API限流 (opens new window)
  2. 调用次数:标准版钉钉组织,该组织内所有企业内部应用、委托第三方定制开发企业内部应用,除不纳入每月调用量限制的接口(包括获取访问凭证接口、身份验证(免登)接口、通讯录接口等,详细接口请查看附录A:不纳入每月调用量限制的接口清单 (opens new window))之外,其他接口累计可调用次数调整为10000次/月

若在代码优化后仍无法满足需求,您可联系钉钉客户经理、钉钉城市经理或钉钉的区域服务商,升级到钉钉专业版 (opens new window)钉钉专属版 (opens new window)的扩容权益来解决。

钉钉标准版接口累计可调用次数为1万次/月。若该调用量无法满足需求,你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

# API Explorer调试工具

钉钉开放平台提供了API Explorer方便开发者调用服务端API。

API Explorer (opens new window)是可视化在线API调用工具,可实时查看API请求和返回结果。

# 二、接入钉钉考勤

# 1、开发环境准备

  1. 需要有一个钉钉注册企业,如果没有可以创建:https://oa.dingtalk.com/register_new.htm#/ (opens new window)

  2. 成为钉钉开发者,参考文档:https://developers.dingtalk.com/document/app/become-a-dingtalk-developer (opens new window)

  3. 登录钉钉开放平台后台创建一个H5应用: https://open-dev.dingtalk.com/#/index (opens new window)

  4. 配置应用

    配置开发管理,参考文档:https://developers.dingtalk.com/document/app/configure-orgapp (opens new window)

  5. 配置相关权限

    权限申请,参考文档:https://developers.dingtalk.com/document/app/address-book-permissions (opens new window)

# 2、API调用限制次数

钉钉官方文档——查看API调用次数

根据钉钉平台规定,每月对调用量有限制的接口进行调用,需要累计次数,且有次数限制。

每月累计可调用次数调整为10000次/月

# 3、考勤API接口 (opens new window)

开发者通过API接口可以实现考勤和企业业务系统打通。

# 4、常用场景接入流程

钉钉提供了考勤组管理、假勤审批及考勤补卡等常用场景的使用流程示例。

# 5、考勤接口接入流程 (opens new window)

  1. 登录开发者后台 (opens new window)。在应用开发页面,创建企业内部应用 (opens new window)
    • 应用类型:选择H5微应用。
    • 开发方式:选择企业自主开发。
  2. 获取AppKey和AppSecret。
  3. 添加接口调用权限 (opens new window)。搜索“考勤”,申请考勤对应的权限。
  4. 获取应用访问凭证获取企业内部应用的access_token (opens new window)。调用接口时,通过accessToken鉴权调用者身份。
  5. 调用考勤相关接口。

# 6、快速体验

可以通过点击Demo案例——open-dingtalk/h5app-attendance-demo (opens new window),下载Demo后就可以快速体验。此Demo主要展示考勤相关模块功能,包括考勤规则模块、考勤打卡模块、考勤统计模块、假期审批模块等。

本demo使用接口相关权限:

  • 通讯录管理——成员信息读权限
  • 考勤——企业考勤数据上传权限
  • 考勤——考勤组管理权限
  • 考勤——查询企业考勤数据权限

# 三、服务端Stream模式 (opens new window)

Stream 模式是钉钉开放平台提供的一种集成方式,它可以监听机器人回调、事件订阅回调和注册卡片回调。使用 Stream 模式接入,钉钉开放平台将通过 Websocket 连接与应用程序通讯,Stream 模式将极大降低接入门槛和资源依赖,不需要公网服务器、IP、域名等资源,只需集成钉钉开放平台 SDK 即可。

# 配置Stream推送

https://open.dingtalk.com/document/orgapp/stream (opens new window)

# 四、钉钉配置

# 1、登录

https://open-dev.dingtalk.com/

  1. 使用企业钉钉管理员账户登录钉钉开放平台:钉钉官方开放平台 (opens new window)

  2. 登录成功后,选择组织进入钉钉开放平台。

  3. 点击右上角“我的后台”,进入后台管理平台。

# 2、配置IP白名单

  1. 点击“开发管理”菜单。

  2. 在“服务器出口IP”中,键入当前服务部署所在电脑的公网IP地址,进行白名单配置。

3、API调用

# 五、钉钉相关资料

钉钉开发平台 (opens new window)

开发者后台 (opens new window)

查看企业内部应用 (opens new window)

权限申请 (opens new window)

查看API调用次数 (opens new window)