钉钉设计文档

钉钉开发设计文档

接口地址

1.后台登陆功能

登陆流程图

image

登陆回调接口
GET /login/callback?authCode=xxxx
权限拦截
AuthorizationIntercept

管理账号授权表

钉钉用户唯一Id	用户名称	是否授权	最后登陆时间
uniodId	user_name	authorization	last_login_time

钉钉免登陆配置表

业务code(自定义)	名称	应用Id	应用密钥
login_code	app_name	app_id	app_secret

2.E应用管理

添加应用
POST /app/add
入参

参数	参数类型	说明
app_code	String	应用编码,用来区分不同应用
app_name	String	应用名称
app_logo	String	应用Logo
suite_id	String	应用Id
suite_key	String	应用Key
suite_secret	String	应用密钥
token	String	应用令牌
aes_key	String	AES加密码

删除应用
POST /app/delete
入参
suite_id

应用表结构

应用编码自己定义	应用名称	应用Logo	应用Id	应用Key	应用密钥	应用令牌	加密码	授权票
app_code	app_name	app_logo	suite_id	suite_key	suite_secret	token	aes	suiteTicket

3.事件回调&令牌授权模块

流程图

image

回调接口

/callback/{suiteId}

参数	参数类型	说明
suiteId	String	建立好E应用APP时获取

企业应用授权关系表

公司id	应用code
coperId	appCode

4.用户模块

绑定用户接口
POST /user/bind

参数	参数类型	说明
telephone	String	用户手机号码
unionId	String	钉钉平台用户Id

获取用户基本信息
GET /user/{unionId}

参数	参数类型	说明
unionId	String	钉钉平台用户Id

返回

参数	参数类型	说明
telephone	String	用户的手机号码
username	String	用户的名称

用户关系表

用户手机号码	钉钉平台用户Id
telephone	unionId

5.钉钉开放功能

数据结构

image

1.发消息接口

POST /message/work_notice

参数	参数类型	说明
telephone	String	用户手机号码
coper_id	String	公司ID
app_code	String	应用业务编码
content	String	消息内容

6.组织结构模块

数据结构

image

公司员工表

公司id	钉钉平台id
coper_id	uniond

部门表

公司id	部门id	部门名称	父部门id
coper_id	dept_id	dept_name	parent_id