文档中心 > 上架应用市场

套件开发

更新时间:2018/06/20 访问次数:68419

业务场景

在本章节,可以通过创建套件、创建微应用、调用开放平台API、开发微应用、进行套件开发,通过创建测试企业对微应用进行调试。

1. 创建套件

登录 钉钉开发者后台,开发者可以创建套件、编辑套件。

基本流程

1.1 登录钉钉开发者后台,切换“ISV开发者视图”,在套件管理中,点击“创建套件”。

createtj

1.2 填写创建套件表单

createtjbd

数据项说明:

字段 属性
名称 套件的名称
套件Logo 上传大小不超过1M,长宽等比且范围在50px至200px之间的png格式图片
Token 可任意填写,用于生成签名、校验回调请求的合法性。本套件接收的回调消息都使用该值来解密。
数据加密密钥 回调消息加解密参数,是AES密钥的Base64编码,用于解密回调消息内容对应的密文。本套件接收的回调消息都使用该值来解密。
IP白名单 调用钉钉API时的合法IP列表,多个IP请以“,”隔开,如IP有变化,请立即更新

1.3 验证回调URL有效性

套件URL有效性校验填写的参数例如:suiteKey、数据加密密钥(EncodingAESKey)、token等信息。同时,需要将这些配置信息配置到我们提供的ISV demo中,并且在当前页面填写一个套件的回调地址,回调接口的写法请参考回调接口

数据项说明:

字段 属性
回调URL 以http:// 或 https:// ; 开头,系统将会把此套件的SuiteTicket,临时授权码以及授权变更事件推送给此URL,详细请看回调接口

checkurl

开发者需要将自己设置的Token、suiteKey、数据加密密钥配置到示例demo中的配置文件中,再点击“验证回调URL有效性”方可验证生效。

回调URL的数据参数:

开发者点击“验证URL的有效性”后,钉钉服务器将发送GET请求到填写的服务器地址URL上,GET请求携带参数如下表所示:

字段 属性
signature 加密签名
timestamp 时间戳
nonce 随机数

开发者通过检验signature对请求进行校验(下面有校验方式)。若确认此次GET请求来自钉钉服务器,在接收到推送之后,需要返回“success”的加密值,加密方案请参考:加密方案说明

当您注册套件时,钉钉服务器为了避免无效推送,将会验证回调url的有效性,对回调url推送“验证回调URL有效性事件”,收到推送后您需要需要返回“success”的加密值,才能成功创建套件。详细处理步骤请查看回调接口和“验证回调URL有效性事件”。

checkurl2

1.4 管理套件

进入套件管理页面:
checkurl2
在套件管理页面可以看到套件的基本配置信息,比如套件Key,套件secret。套件的suiteKey和suiteSecret在套件授权的过程中会用到,注意:suiteSecret 需要配置到项目的配置文件中,具体参考:套件授权

2. 创建微应用

基本流程

2.1 查看套件基本信息

checkurl2

2.2 点击“创建微应用”按钮

createmini1

2.3 填写创建微应用表单,点击“确定”按钮

createmini2

注意:如果修改此处的主页入口地址,用户客户端上不会立即生效,需要等待一段推送的时间。假设主页地址从url A修改为url B,为了保证高可用性,需要保证url A的服务依然可被访问,同时A的服务端重定向到url B;另外,A的服务监控访问量,在访问量逐步降低到一个可接受的范围后,再关闭A的服务。

需要提供的数据项:

字段 属性
名称 应用的名称,2-16个字
图标 上传大小不超过1M,长宽等比且范围在50px至200px之间的png格式图片
应用描述 描述该应用的功能与特色,4-120个字内
主页地址 微应用移动客户端主页地址,以http:// 或 https://  开头,URL支持使用$CORPID$模板参参数获取corpid,用户访问应用的时候把$CORPID$替换成用户所属企业的corpid,例如http://www.dingtalk.com/index?corpid=$CORPID$
PC主页地址 微应用PC端主页地址,以http:// 或 https://  开头,URL支持使用$CORPID$模板参参数获取corpid,用户访问应用的时候把$CORPID$替换成用户所属企业的corpid,例如http://www.dingtalk.com/index-pc?corpid=$CORPID$
后台地址 微应用管理后台的地址,例如http://www.dingtalk.com/admin
可获取用户信息 此处权限会在用户授权套件时进行显示告知用户套件所需要获取的企业员工信息。当企业用户授权后,可以通过获取部门成员(详情)接口获取员工的详细信息
可调用接口 用户授权套件时告知用户套件所需要获取的成员信息。

2.4 微应用创建成功

createmini3

应用服务商(ISV)默认无管理通讯录的权限,需将应用部署在钉钉云上面(参考钉钉云接入指南)才可以申请通讯录权限,参考通讯录权限获取指南。微应用测试调试阶段需通讯录查询权限,可创建测试企业获取,详见本文3.注册测试企业

3. 注册测试企业

在应用未正式发布之前,需要开发者在授权管理中使用测试企业进行授权,之后钉钉服务器会向您填写的回调url推送企业授权的临时授权码,你需要通过临时授权码一步一步操作到激活授权套件,才能让测试企业的工作面板的微应用列表出现您开发的微应用。

当前支持最多创建10个测试企业,且创建的测试企业已默认开通通讯录的查询权限,调试套件时可直接使用,无需单独申请通讯录权限。

基本流程

3.1 测试企业管理,点击“创建测试企业”

signintest1

3.2 填写企业相关信息

signintest2

3.3 创建成功

signintest3

3.4 点击“套件管理”后,选择一个套件,点击后面的“管理”按钮,再选择给要授权的测试企业,点击“授权”,对微应用进行授权。

注意:创建套件填写的回调接口能够正常接收推送,才能成功开通微应用,具体详情查看回调接口

signintest4
signintest4

3.5 点击测试企业管理,选择一个测试企业,然后点击“登录管理”跳转到 钉钉企业管理后台,且需使用原管理账号进行登录,如截图所示:

signintest5
signintest5

点击原管理账号登录

signintest6
signintest6

4. 开发套件

 1.钉钉开放平台提供了一组应用接入与授权的接口,通过实现接入与授权接口,开发者可以快速发布自己的套件。在企业用户授权开通套件时,开发者需要为企业主动激活套件。企业用户可以在授权后直接使用您的套件(应用),接口使用可以参考ISV应用授权流程

 2.钉钉开放平台提供了企业通讯录管理、文件管理、企业会话消息等功能,接口使用可以参考服务端开发文档

 3.我们提供了一组可以调用钉钉的本地能力和业务逻辑的JSAPI,开发者可以通过这些接口调用钉钉的原生控件,降低开发成本,提升微应用在移动客户端的体验。接口使用可以参考移动端开发文档

 4.钉钉开放平台提供了与钉钉PC版本集成的能力,接口使用可以参考PC端开发文档

 5.钉钉开放平台提供了开发过程中需要的调试工具和性能优化的建议,您可以参考调试工具性能优化

FAQ

关于此文档暂时还没有FAQ
返回
顶部