> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.
# SaaS应用开发指南
> 本文档提供了使用钉钉（宜搭）酷SaaS工厂开发应用的全链路流程说明，包括低代码开发SaaS应用的前置准备、进入SaaS研发工作台的方法、aPaaS底座功能支持范围、主应用设计、酷应用设计以及如何发布和上架您的应用。
[📎627钉钉（宜搭）酷SaaS工厂应用开发指南大纲.pdf](https://www.yuque.com/attachments/yuque/0/2023/pdf/5376772/1687837298944-cab5ea65-83a2-4220-9ad2-21b6831c320e.pdf)
## 1 低代码开发SaaS应用全链路流程说明
参考[合作全流程指引 - 开放平台](https://open.dingtalk.com/document/operation-specification/isv-cooperation-guide?spm=a2q3v.21449185.0.0.7e676febWCbVi1)
### 1.1 前置准备
申请钉钉产品服务商资质
了解并知悉[钉钉开放平台ISV帮助中心](https://alidocs.dingtalk.com/i/p/KrwmPQ5g4OEAG79n/docs/3KLw95QMzkb8gGOpYEk78AjrymPeEN2q?dontjump=true)的全链路内容
SaaS应用必须具备酷应用形态，如何酷化可参考[低代码构建钉钉酷应用开发设计指南](https://alidocs.dingtalk.com/i/p/Y7kmbokZp3pgGLq2/docs/7Y36k14mK9AV35vAPyg185NqapjblR2D)
### 1.2 如何进入SaaS研发工作台
当前组织具备[产品方案商](https://open.dingtalk.com/document/operation-specification/isv-cooperation-guide?spm=a2q3v.21449185.0.0.7e676febWCbVi1)身份认证时，登录宜搭，可在顶部菜单看到“进入SaaS研发工作台”的入口，直接访问。
进入SaaS应用工作台，您可以创建SaaS应用。
### 1.3 aPaaS底座功能支持范围
钉钉SaaS工厂研发工作台的能力和宜搭现有交互模式基本保持一致，本期发布的版本将会具备以下核心功能点\*\*：\*\*
* 平台功能：
特殊说明：自定义连接器、数据准备、DataV大屏、自定义组件等扩展增强功能，暂不支持，后续将会持续迭代。
## 2 主应用设计
> 在完成前置准备工作后，您可以研发SaaS应用，如果您在现有其他宜搭组织下已经有完备的解决方案，希望直接切换成SaaS模式，可联系宜搭产研申请应用迁移至SaaS环境。
1. 您可以基于SaaS研发工作台并且根据目前平台提供的能力，按照业务诉求设计您的应用，如设计：
目前以上功能开发流程和宜搭企业自建应用开发功能保持一致，如有问题，请联系宜搭团队。
2. 如果您的SaaS品有相关业务底表数据且希望用户在订阅SaaS应用后，能看到相关示例数据， 请录入“基础数据”并统一维护至一个目录文件夹内，文件命名“ 基础业务数据 ”（示例如下图）
## 3 酷应用设计
基于SaaS研发工作台，您可以在应用层：卡片管理/集成自动化流 内 配置酷应用的卡片样式及卡片的发送及更新逻辑。具体设计可参考如下文档：
## 4 应用发布
主应用和酷应用都开发完毕后，您可以进入“发布&上架”界面，创建一个新的版本，用于SaaS应用的功能测试，测试完毕后申请上架。
### 4.1 应用版本管理
* 应用功能发生变化之后，您可以随时创建一个新的版本，默认版本状态为“未发布”状态。可以点击发布，发布该版本。
### 4.2 应用申请上架-关联第三方应用
#### step1 关联第三方应用
| **SaaS研发工作台** | **钉钉开放平台>企业第三方应用** |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
1. 创建完至少一个应用版本后，可在 上架到钉钉应用中心内 提交上架申请
2. 选择在开放平台注册的第三方应用，在此关联选择即可。
| 
1. 在钉钉开放平台内 > 企业第三方应用 类目下 创建H5微应用，填写应用基础信息
2. 生成应用凭证
|
#### step2 填写SaaS应用开发信息
复制SaaS应用地址，进行应用信息配置
| **SaaS研发工作台** | **钉钉开放平台>企业第三方应用** |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 
1. 完成步骤1后，点击“复制”，将上述链接复制到开放平台，如右图 | 
1. 在钉钉开放平台内 > 企业第三方应用 选择注册的三方应用，点击“开发管理”，填写：
|
#### step3 检查SaaS应用配置项
##### （1）确认应用开发信息
1. 在钉钉开放平台内 > 企业第三方应用 选择注册的三方应用，如上图确认功能配置项是否均已完成，遗漏的需要继续配置。
##### （2）权限管理配置
为保障SaaS品的数据安全，应用在开通时需要向用户确认授权信息，因此需要ISV自行配置需要授权的权限点。
1. 选择“权限管理”菜单， 标准SaaS品均需要勾选以下权限信息，勾选后点击“批量申请”。
| **权限分类** | **权限点** |
| -------- | -------------------------------------------------------- |
| 卡片 | 互动卡片实例写权限 |
| 个人权限 | 通讯录个人信息读权限 |
| 通讯录管理 | 通讯录部门信息读权限
通讯录部门成员读权限
查询行业通讯录信息权限
成员信息读权限 |
| 待办任务 | 待办应用中待办写权限
待办应用中待办读权限 |
| 应用授权 | 调用ISV专有API时需要具备的权限 |
| 身份验证 | 企业微应用后台免登接口的访问权限 |
| 场景群 | chat相关接口的管理权限
chat相关接口的读取权限 |
| 宜搭 | **全部勾选** |
| 机器人 | 企业内机器人发送消息权限 |
| 存储 | 企业存储空间读权限
企业存储文件写权限
企业存储文件读权限 |
（图1 权限配置界面）
（图2 授予权限透出说明界面）
2. 如果当前您搭建的SaaS品在“集成自动化>连接器节点”使用了“钉钉官方”连接器，请联系宜搭同学，确认需要勾选一方连接器的权限。
部分连接器与权限的映射如下
| **连接器** | **对应的权限分类** | **对应的权限点** |
| ------------------------------------------------------------------------------------------------------------------------ | ----------- | ----------- |
|  | 智能会议室 | 视频会议应用会议写权限 |
|  | 项目管理 | 项目应用任务写权限 |
#### step4 自助申请跳过安全自检
1. 应用跳过自检，需要设置“事件与回调”，如下图：
**step1**：加密Aes\_key，通过下列的**decrypt**方法对宜搭的**systemToken**进行加密后设置
```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
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);
}
```
宜搭的systemToken在宜搭应用设置-部署运维中获取
**step2**：签名Token，即为上面的宜搭的systemToken
**step3**：回调请求地址（[https://www.yidaapps.com/saasAppCallback/\\\{appKey}）](https://www.yidaapps.com/saasAppCallback/\\\{appKey}）) 其中appKey是宜搭应用的，如“APP\_XXX”的应用编码
2. 填写应用自检《安全审核》相关内容，安全准入评估参考 📎宜搭酷SaaS安全准入指南-ISV .pdf
### 4.3 体验组织管理
体验组织管理用于ISV自测 已发布/未发布状态下 主应用/酷应用的功能完备性，自测通过后再申请上架到钉钉应用中心和酷应用市场。
选择对应的SaaS应用版本，点击”体验组织管理“，选择体验组织，如果无，可点击 ”创建“ ，前往开放平台进行创建体验组织。
体验组织创建完毕后，可将需要测试的应用版本关联授权到该组织即可，授权成功后，可在该体验组织的工作台>未分组 下查看该应用。
#### 4.3.1 体验测试主应用
通过工作台访问该应用后，当体验测试组织人非“通讯录的管理员”或”应用主管理员“时，可联系组织管理员或应用管理员添加进入应用后台的管理权限。
**以下功能均支持修改：**
> 通用逻辑说明：一旦修改后，后续ISV升级版本后，对应功能有变更，客户侧订阅后将以本地修改的配置为主，不会同步更新主应用的变更到子应用；如果未修改，主应用增量资源变更将会同步至子应用。
>
> 审批流程修改变更逻辑说明：
>
> 1. 如果子应用订阅了V0版本，如果主应用有未发布的V1版本，在子应用历史版本中不予展示
> 2. 如果子应用订阅了V0版本，并未进行自定义，后续主应用升级到V1版本，子应用也应该按订阅的V0版本进行展示和运行
> 3. 如果子应用订阅了V0版本，并进行自定义，会创建一份自己内部的V0历史版本，然后创建一份V1的草稿态，同时子应用订阅新版本应用后，当前流程不再跟随主应用升级
> 4. 以上流程版本包括版本内的所有业务规则和公式
3. 默认会将主应用内“基础业务数据”表单数据携带至子应用，保障底表数据开箱即用，支持修改。
#### 4.3.2 体验测试酷应用
主应用测试通过后，可测试酷应用，首先提交酷应用相关信息。点击“上架到钉钉酷应用市场>提交上架申请”，填写酷应用上架信息，包括酷应用基础信息、访问入口（最多可配置3个）及打开方式、机器人信息等。
## 5 应用运维
### 5.1 版本升级
服务商开发的SaaS应用上架到应用市场后，客户付费订阅当前SaaS应用后，ISV如有功能迭代，支持在"宜搭SaaS研发工作台>应用设置>远程运维"针对特定组织进行SaaS应用功能逐个/批量进行版本升级。
功能说明：
1. 默认可升级的版本功能范围为当前已发布之后迭代的最新版本列表
2. 支持针对多个付费组织进行批量版本升级
> 远程运维敬请期待
### 5.2 应用开通授权背景页设置
当宜搭SaaS应用上架到钉钉开放平台和应用中心后，支持自定义授权开通背景介绍页内容👉[了解更多](https://open.dingtalk.com/document/isvapp/1-product-interaction-process)
配置说明：
* 分别上传PC端/移动端开通授权背景页面（仅支持上传一张）
* 上传完毕后复制“试用访问地址”后前往 伙伴自运营平台 > 第三方企业应用 > 商品上架管理 > 应用详情 > 管理 “应用内授权设置”信息 ，接入完成且自行验收通过后 （ 👉 详细了解验收流程 ） ，该SaaS应用可在钉钉线上更多渠道进行推广（如钉钉搜索等场域）
| 
移动端效果 | 
PC端效果 |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
## 6 常见FAQ
答：表单等功能支持已支持
答：禁止已上线发布的普通｜流程表单删除组件，包括子表单。
答：任意自定义链接中不可携带固定的CorpId
答：请在“非主应用组织内新建内部群”安装酷应用进行测试。
请参考《酷应用高频FAQ及典型场景设计指南》
答：当宜搭页面被集成到其他系统内时，支持配置隐藏顶部导航栏和左侧页面功能导航栏。在被嵌入的页面URL后拼接?isRenderNav=false即可。