场景
需要做后台管理系统,接入钉钉API获取人员、考勤、审批等相关数据。
实现
钉钉开放平台应用开发文档
https://developers.dingtalk.com/document/app
首先需要联系钉钉的管理员,登录钉钉的后台,然后按照开发平台的文档指示
首先创建应用
然后填写应用的基本信息
让管理员创建应用的目的就是为了获取下面这两个AppKey和AppSecret
使用管理员登录钉钉管理平台并创建应用后,就是为了获取上面的AppKey和AppSecret,然后拿着这两个调用钉钉的接口,钉钉会返回token
调用其他的接口需要使用这个token。
注:
博客主页:
https://blog.csdn.net/badao_liumang_qizhi
关注公众号
霸道的程序猿
获取编程相关电子书、教程推送与免费下载。
然后在权限管理里面需要设置此应用有哪些权限
默认只有登录权限和消息通知的权限,然后可以在添加接口权限中添加需要用到的权限
选择完成之后点击确认。
Java开发流程
钉钉官方提供了统一的SDK,使用SDK可以便捷地调用服务端API。
下载之后将服务端sdk引入到项目中
在钉钉开放平台-开发工具-服务端API调试工具-API Explorer中可以直接将上面的两个AppKey和AppSecret复制过来然后选择语言进行调用
比如在Java中调用获取token的接口示例代码为
public String getToken() throws ApiException { DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/gettoken"); OapiGettokenRequest req = new OapiGettokenRequest(); req.setAppkey("钉钉后台应用的AppKey"); req.setAppsecret("钉钉后台应用的Appsecret"); req.setHttpMethod("GET"); OapiGettokenResponse rsp = client.execute(req); System.out.println(rsp.getBody()); return rsp.getAccessToken(); }
然后获取token之后就可以使用这个token去访问钉钉的其他接口
比如通讯录管理下的部门管理中获取部门列表的接口,在中间按照要求填入参数,则在右边就会生成相关代码
示例代码
public class Main { public static void main(String[] args) { try { DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/department/list"); OapiDepartmentListRequest req = new OapiDepartmentListRequest(); req.setLang("zn_CN"); req.setFetchChild(false); req.setId("1"); req.setHttpMethod("GET"); OapiDepartmentListResponse rsp = client.execute(req, "dsfsfdsfgs你获取的token"); System.out.println(rsp.getBody()); } catch (ApiException e) { e.printStackTrace(); } } }
其他钉钉的API接口的访问流程类似。
其他
1.因为钉钉对接口访问的API的频率等有限制,建议在定时任务里调用钉钉相关接口,将数据获取并存储到自己的数据库中进行查询。
2.因为补卡机制,所以如果要获取考勤数据的话,比如允许补卡3天内的考勤数据,那么每天获取前四天的数据并进行覆盖
3.如果在调用接口时出现如下提示:
请求的部门id不在授权范围内
联系钉钉管理员登录后台,找到应用下的权限管理
把这里的权限范围改为全部员工
4.另外,钉钉要求访问其接口的ip地址必须提前配置,在开发管理里面的服务器出口ip
钉钉只允许在这里配置ip的服务器去调用其接口
如果在开发接口使用自己的电脑调用时,需要获取公网的服务器ip,浏览器百度Ip获取代理商的ip
不过这个ip会频繁改变,一旦请求接口出现ip不在白名单的情况,就要去重新查询,然后重新配置出口Ip。
所以建议将定时任务写好,直接将取数据的环节部署在公网服务器上,并配置服务器出口ip,这个ip可以设置多个,用逗号隔开。