SaaS应用开发指南

📎627钉钉（宜搭）酷SaaS工厂应用开发指南大纲.pdf

1 低代码开发SaaS应用全链路流程说明

参考合作全流程指引 - 开放平台

1.1 前置准备

申请钉钉产品服务商资质步骤一：入驻成为产品方案商 - 开放平台
了解并知悉钉钉开放平台ISV帮助中心的全链路内容
SaaS应用必须具备酷应用形态，如何酷化可参考低代码构建钉钉酷应用开发设计指南

1.2 如何进入SaaS研发工作台

当前组织具备产品方案商身份认证时，登录宜搭，可在顶部菜单看到“进入SaaS研发工作台”的入口，直接访问。

进入SaaS应用工作台，您可以创建SaaS应用。

1.3 aPaaS底座功能支持范围

钉钉SaaS工厂研发工作台的能力和宜搭现有交互模式基本保持一致，本期发布的版本将会具备以下核心功能点：

平台功能：

表单（数据联动、自定义页面（页面js）、关联列表、二维码、流水号等）
流程（消息通知、待办等）
报表（元数据、数据集）
公式&业务规则
权限
集成自动化（一方、三方连接器、定时触发等）
消息通知&待办
酷应用化
打印
页面js数据源的openAPI
门户
数据卡片搭建（主应用不支持数据卡片投放>数据播报配置但支持子应用个性化定制数据播报能力）
...等

特殊说明：自定义连接器、数据准备、DataV大屏、自定义组件等扩展增强功能，暂不支持，后续将会持续迭代。

2 主应用设计

在完成前置准备工作后，您可以研发SaaS应用，如果您在现有其他宜搭组织下已经有完备的解决方案，希望直接切换成SaaS模式，可联系宜搭产研申请应用迁移至SaaS环境。

您可以基于SaaS研发工作台并且根据目前平台提供的能力，按照业务诉求设计您的应用，如设计：

表单
流程
报表
门户
数据卡片搭建（主应用不支持数据卡片投放>数据播报配置但支持子应用个性化定制数据播报能力）
集成自动化
酷应用
...

目前以上功能开发流程和宜搭企业自建应用开发功能保持一致，如有问题，请查看图解宜搭 | 钉钉宜搭·帮助中心

如果您的SaaS品有相关业务底表数据且希望用户在订阅SaaS应用后，能看到相关示例数据，请录入“基础数据”并统一维护至一个目录文件夹内，文件命名“基础业务数据”（示例如下图）

届时该文件夹的各普通表单TOP100的数据将会随着客户订阅应用时加载到对应的组织应用内，目前仅支持一级目录携带数据，暂不支持多级目录。

3 酷应用设计

基于SaaS研发工作台，您可以在应用层：卡片管理/集成自动化流内配置酷应用的卡片样式及卡片的发送及更新逻辑。具体设计可参考如下文档：

酷卡片设计 | 钉钉宜搭·帮助中心

酷流程设计 | 钉钉宜搭·帮助中心

4 应用发布

主应用和酷应用都开发完毕后，您可以进入“发布&上架”界面，创建一个新的版本，用于SaaS应用的功能测试，测试完毕后申请上架。

点击新建版本，填写SaaS应用的版本信息，包括版本号、版本描述内容。

版本号不可修改
版本创建后，您可以点击“描述设置”修改版本描述

4.1 应用版本管理

应用功能发生变化之后，您可以随时创建一个新的版本，默认版本状态为“未发布”状态。可以点击发布，发布该版本。

⚠️未来用户在应用市场或自有渠道购买SaaS应用时，默认下单购买的版本为当前主应用已发布的最新版本，未发布的版本用户无法购买。

4.2 应用申请上架-关联第三方应用

step1 关联第三方应用

SaaS研发工作台

钉钉开放平台>企业第三方应用

创建完至少一个应用版本后，可在上架到钉钉应用中心内提交上架申请
选择在开放平台注册的第三方应用，在此关联选择即可。

⚠️ 一旦关联无法修改，请确认清楚后再进行绑定，如果关联错误，请联系宜搭官方。

在钉钉开放平台内 > 企业第三方应用类目下创建H5微应用，填写应用基础信息
生成应用凭证

⚠️ 凭证里的字段信息涉及隐私请妥善保管

step2 填写SaaS应用开发信息

复制SaaS应用地址，进行应用信息配置

SaaS研发工作台

钉钉开放平台>企业第三方应用

完成步骤1后，点击“复制”，将上述链接复制到开放平台，如右图

在钉钉开放平台内 > 企业第三方应用选择注册的三方应用，点击“开发管理”，填写：

服务器出口IP：填写127.0.0.1
应用首页地址/PC端首页地址：直接粘贴链接即可（请务必填写左图生成的“复制”链接！！非应用URL链接）

step3 检查SaaS应用配置项

（1）确认应用开发信息

在钉钉开放平台内 > 企业第三方应用选择注册的三方应用，如上图确认功能配置项是否均已完成，遗漏的需要继续配置。

（2）权限管理配置

为保障SaaS品的数据安全，应用在开通时需要向用户确认授权信息，因此需要ISV自行配置需要授权的权限点。

选择“权限管理”菜单，标准SaaS品均需要勾选以下权限信息，勾选后点击“批量申请”。

权限分类	权限点
卡片	互动卡片实例写权限
个人权限	通讯录个人信息读权限
通讯录管理	通讯录部门信息读权限通讯录部门成员读权限查询行业通讯录信息权限成员信息读权限
待办任务	待办应用中待办写权限待办应用中待办读权限
应用授权	调用ISV专有API时需要具备的权限
身份验证	企业微应用后台免登接口的访问权限
场景群	chat相关接口的管理权限 chat相关接口的读取权限
宜搭	全部勾选
机器人	企业内机器人发送消息权限
存储	企业存储空间读权限企业存储文件写权限企业存储文件读权限

（图1 权限配置界面）

（图2 授予权限透出说明界面）

如果当前您搭建的SaaS品在“集成自动化>连接器节点”使用了“钉钉官方”连接器，请联系宜搭同学，确认需要勾选一方连接器的权限。

部分连接器与权限的映射如下

连接器

对应的权限分类

对应的权限点

智能会议室

视频会议应用会议写权限

项目管理

项目应用任务写权限

step4 自助申请跳过安全自检

应用跳过自检，需要设置“事件与回调”，如下图：

step1：加密Aes_key，通过下列的decrypt方法对宜搭的systemToken进行加密后设置

private static final char[] HEX_ARRAY = "0123456789abcdef".toCharArray();
    
public static String bytesToHex(byte[] bytes) {
        char[] hexChars = new char[bytes.length * 2];
        for (int i = 0; i < bytes.length; i++) {
            int v = bytes[i] & 0xFF;
            hexChars[i * 2] = HEX_ARRAY[v >>> 4];
            hexChars[i * 2 + 1] = HEX_ARRAY[v & 0x0F];
        }
        return new String(hexChars);
    }

    
private static String decrypt(String input) throws NoSuchAlgorithmException {
        MessageDigest digest = MessageDigest.getInstance("SHA-256");
        byte[] hash = digest.digest(input.getBytes(StandardCharsets.UTF_8));
        // 将散列码转换成43位加密串
        return bytesToHex(hash).substring(0, 43);
}