> ## 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.

# 产品设计规范

> 1.1 微应用的产品名称及icon清晰可识别，不能与平台内其他微应用的产品及icon相似度过高(以审核人员主观判断为准）；

## 1. 产品名称和图标规范：

1.2 微应用产品名称应该与品牌、服务场景、核心功能有关联，命名不超过5个汉字，开发者应取得该名称的注册商标；

1.3 微应用名称不能以通用名称等不具有识别性的词语来命名，比如：CRM、ERP、进销存、财务软件。名称建议是两个词以上的组合，当无法判断时，审核人员可主观判断是否可用；

1.4 微应用icon标准尺寸为：200\*200，不规则icon的边缘需要以200\*200尺寸描边；

1.5 微应用头像logo不得包含阿里巴巴、淘宝、支付宝、蚂蚁金服、钉钉、阿里云等官方品牌标识（阿里巴巴集团自开发应用除外）。

1.6 任何涉及违反国家法律法规的名称和icon都将被拒绝。

## 2.产品完整度需要符合使用场景MVP最小闭环：

2.1 应用需明确满足某一类核心用户群体的办公或者商务需求，应完成核心需求的最小闭环；

2.2 有且仅有一个主流程，如培训管理产品，选课-安排学习-考试-统计是一个主流程；

2.3 核心场景的流程需要设计为闭环状态，核心流程的任何断点，均会被拒绝；

## 3.产品功能交互的可用性和完整性：

3.1 应用提审时应是完成品，可以打开，可以运行，不可以是测试版。存在严重bug（如无法添加和打开、无法返回和退出、卡顿严重等），本身会崩溃，或应用会造成钉钉客户端崩溃的，将会被拒绝。

3.2 非首次进入应用的目标用户使用时需要能够在1-2步操作以内，未经指导即可进入到核心流程；

3.3 突出主功能、主流程，将较少使用的次要功能、分支流程折叠到“更多”或类似“高级选项”列表中，包括表单中的非必填项、一个页面中的次要操作等；

3.4 如应用有PC端使用场景，应同时开发PC端；不允许仅有OA管理后台的web版微应用管理后台，而没有PC端微应用管理后台。

3.5 PC端微应用所有页面在容器内打开，避免跳转至外部浏览器打开；

3.6 整体功能体验中，产品体验应该是稳定健康的，用户可感知流程步骤和页面跳转的目的性。

3.7 微应用需要考虑不同角色用户的页面展示主次及逻辑，如果涉及不同权限的产品审核，isv需要提前预置数据，准备不同角色的测试账号供审核人员验证；

3.8 非极端弱网环境下，内容加载、页面的切换等待之间最长不超过4秒；

3.9 如需要账号体系，应用应与钉钉打通免登能力，不允许应用存在需要用户输入手机号码等隐私数据注册登录的自有的账号体系；

3.10 应用需要使用应用内支付能力时，需通过开放平台提供的统一支付插件进行调用，平台不支持其他支付形式；

3.11 应用的功能的使用，无需以转发、分享、打开其他微应用等非用户自愿行为解锁；

3.12 在未经允许或未被钉钉开放平台授权的情况下，不得展示和推荐自有或者第三方应用。比如：不能做应用中心，应用导航、应用链接互推、排行榜等。

## 4.产品设计及文案内容的细节体验要求

4.1 产品设计需有用户的视角，让丝毫不了解产品的用户能够理解。而不是站在开发者的视角。如CRM产品成功创建一个客户，不应该提示为“写入数据库成功”，而应该是“创建客户成功”；

4.2 文案应避免与钉钉的功能产生混淆，如使用钉钉功能时，应与钉钉的文案保持一致，如DING功能为大写字母，不应写成Ding或ding。审批功能特指钉钉审批，日志功能特指钉钉日志等。

4.3 文案应通俗易懂，避免出现开发者使用的专业术语。提示语应简明扼要、指代清晰、避免歧义。

4.4 必填项、非必填项应有区分标示，可选项、不可选项应有视觉区分，可输入区域、不可输入区域应明确区分。

4.5 输入纯数字时应自动拉起数字键盘，输入英文时应拉起英文键盘等。非特殊情况下，输入日期时应调用钉钉标准选日期组件。场景为选择未来的时间时，不应可选早于当前的时间。

4.6 用户可能对输入的内容要求不清晰时，应在输入框中用灰色文字透出引导输入的内容。较难理解的输入框，应有小字或问号图标等提示。

4.7 多个表单输入项可归为几个大项时，建议有明确的标题分割，但不要过度依赖标题的分割作用。不要过多使用分割线，保持页面统一和美观。

4.8 相同层级的表单项的间距、字号、颜色应保持一致，居左对齐，上下居中对齐，输入框的宽度应尽量一致，尽量避免在同一行出现两个输入框。

4.9 表单应尽量使用白色背景，表单项名称使用黑色或饱和度较高的灰色，尽量避免使用红色提示语。

4.10 微应用不允许接入广告平台模式，比如信息流广告、漂浮悬浮类广告，含有广告展示类的微应用将会被拒绝。

4.11 微应用代替用户发表、发送、转交任何内容前，必须征得用户明确同意和授权。

4.12 钉钉提倡平等透明的工作方式，避免用“您”、“贵公司”等字眼。

4.13 微应用的服务提供者必须提供过滤不当内容的措施。示例：设置对发布色情、赌博等涉嫌违法违规的词汇进行过滤提示的措施。

## 5.新老用户同时关照

5.1 钉钉企业级应用一般由管理员授权开通，也由管理员决定是否推进使用，第一次打开产品的，绝大多数情况下也是管理员。所以新用户的引导特别是对于管理员的引导尤为重要，必须让管理员快捷、无压力、低成本地体验产品的主要功能，感受到产品的核心价值；

5.2 微应用功能逻辑复杂时，需要针对新用户做独立的引导流程，审核人员可主观判断是否需要增加引导流程；

5.3 完整的新用户引导分两方面：基本操作提示、走完产品主流程；

5.4 完成产品主流程：引导新用户完成产品的主要功能，并在必要的、需要用户大量输入的功能中预置案例，降低体验门槛；

5.5 建议使用蒙层引导、功能tips、完成任务等方式，让用户真实体验产品，不建议使用图片、demo的方式进行引导；

5.6 丰富的预置内容、案例、模板等，让用户能够快速理解；

5.7 建议将引导流程和产品功能相结合，如一个智能客服产品，可以将引导作为知识库放在智能对话框中。一个任务管理产品，可以将引导任务作为预置的任务，要求用户完成；

5.8 产品升级后，新功能须让用户有所感知；

5.9 引导功能需提供跳过能力。

## 6.用户隐私和数据安全

6.1 不得在应用任何页面请求或诱导用户输入钉钉用户名或密码、真实联系方式。

6.2 涉及到向用户推送工作通知的功能时，应尽量使用“用户反馈式”推送。产品中应避免设计主动推送式功能，特殊情况应在产品验收时向钉钉团队说明。

6.3 需要向已授权开通企业管理员主动推送信息，可使用钉钉开发者平台的推送工具，申请后由钉钉团队审核内容并推送。

6.4 企业客户及用户在应用中产生的数据，所有权益归企业所有。

6.5 不得将通过应用收集到的用户数据私下进行出售、转交、交易、越权披露或泄露。

6.6 在收集和使用用户任何数据时，必须明确告知用户该数据的用途，确保经过用户明确同意和授权，并应在用户同意和授权的范围内进行合理使用。

6.7 用户授权开通服务后，除非解除授权时选择删除数据，否则不允许删除用户数据。

6.8 在企业退订服务或者注销帐号后应帮助企业在其指定服务器备份数据后，主动删除非企业指定服务里的相关数据。

## 7.需要包含服务机制

7.1 应用需要提供帮助中心，预置和沉淀在服务客户时整理的FAQ；

7.2 需在应用中提供客服入口，必须为服务群，不允许出现其他的服务方式。

7.3 已上架的应用类商品，应用内的客服等联系入口需要全部切换为服务群，不允许提供单独的电话、钉钉私聊二维码等非服务群方式，应用的改造需要在上架后一周内完成，如在应用迭代审核或应用走查时发现如上不符合规范的客服链路，审核会被拒绝，严重者会要求下架整改。

## 8.差异化竞争点

8.1 产品需要在同类型分类中具备竞争亮点，比如：满足了某一个其他同类没满足的需求、比同类产品设计感好、交互更优等；

8.2 如果产品在同类中产品本身明显不具备竞争亮点，且与ISV交流中也无法提供可验证亮点，审核会被拒绝。

## API接入规范

### 概述

钉钉应用市场致力于为企业用户提供：满足丰富办公场景需求、使用体验优秀、与钉钉实现有意义结合的优质产品服务。第三方应用需使用钉钉开放平台提供的API、SDK，与钉钉实现全面结合，提升用户使用体验，并保证企业在钉钉内的信息同步，与钉钉共同打造体验优秀的钉钉产品生态，创建企业客户愿意为之付费的应用。

本规范将详细介绍第三方应用在开发过程中，使用API的规范。

### 规范细则

**使用场景**

钉钉开放平台已开放丰富多样的API接口，供第三方应用使用，以下是常用使用场景和用户价值，开发者可根据应用内的场景，使用API实现与钉钉的结合。

| **API** | **使用场景**                                   | **用户价值**                     | **开发文档**                                                                                      |
| ------- | ------------------------------------------ | ---------------------------- | --------------------------------------------------------------------------------------------- |
| 免登      | 统一钉钉帐号登录，不允许在应用内要求用户输入登录凭据，不允许通过其他的账号体系登录。 | 统一完整的用户体验                    | [免登概述](/zh/open/development/sso-overview)                                                     |
| 内购      | 在应用内购买高级功能或者产品服务                           | 统一购买渠道，安全有保障                 | 应用内购                                                                                          |
| 消息通知    | 应用内任务或状态变更，需要告知用户，在钉钉内发工作通知                | 在钉钉里接收所有应用的提醒                | [使用模板发送工作通知消息](/zh/open/development/work-notification-templating-send-notification-interface) |
| 待办/工作流  | 应用内有审批或工作流                                 | 在钉钉里统一处理所有工作流，效率高，速度快，体验好    | OA工作流概述                                                                                       |
| 通讯录基础信息 | 获取成员在组织内部的基本信息                             | 统一管理组织内用户信息                  | [通讯录基础信息](/zh/open/development/query-user-details)                                            |
| 通讯录角色   | 获取成员在组织内部的角色                               | 统一管理组织内用户信息                  | [角色详情](/zh/open/development/queries-role-details)                                             |
| 通讯录权限   | 获取管理员在组织内部的权限范围                            | 统一管理组织内用户信息                  | [获取管理员通讯录权限范围](/zh/open/development/query-permissions-of-the-administrator-address-book)      |
| 外部联系人   | 获取组织的客户管理列表与详情                             | 统一管理组织的客户/外部联系人              | [外部联系人](/zh/open/development/obtain-the-external-contact-list)                                |
| 钉盘相关    | 上传文件、发送文件                                  | 在钉钉可以统一管理团队文件                | 钉盘                                                                                            |
| 电话      | 拨打电话联系                                     | 拨打钉钉电话，使用智能办公电话              | 微应用拨打电话  小程序拨打电话                                                                              |
| 选人      | 通讯录选人                                      | 选择组织中的人或部门                   | 微应用选择部门和人  小程序选人与部门                                                                           |
| DING    | 发送紧急通知                                     | 通过DING发送紧急事项，可支持唤起DING、任务、会议 | 微应用发DING  小程序发DING                                                                            |

### 接入要求

首先，为保证用户在钉钉内能够方便简单地使用应用，所有应用都必须接入的API包括：免登、消息通知、通讯录基础信息。

其次，不同类型的应用，所涉及的场景不同，需要使用的API也不同。下表列出了每个类目的应用至少要使用的API，开发者还可以根据应用所属类目和具体场景需求，在开发过程中接入更多的开放平台API。详见API接口调用规范。

**如果应用内不涉及该场景，不需要接入该API，请在产品验收过程中进行说明。**

### 上架验收

应用市场上架流程中安排了API接入的验收，通过这些环节钉钉团队可以更好地了解应用与钉钉的整合情况，有助于促进双方针对应用的产品功能及用户体验等各方面策略的确立和制定。

产品验收提交前，系统会自动检测API接入的情况，请保证基础接口已完成接入并有用户使用。否则无法提交产品验收。

**如果应用内不涉及该场景，不需要接入该API，请在产品验收过程中进行说明。**

| **接口** | **场景**                                              | **截图**          |
| ------ | --------------------------------------------------- | --------------- |
| 免登     | 用户进入该应用，直接使用钉钉免登，直接进入首页，无需用户输入账号和密码，并且能够显示当前用户的昵称等。 | image.png       |
| 内购     | 应用内无内购，不涉及该接口                                       | 应用内无接入场景，不涉及该接口 |
| 消息通知   | 使用钉钉工作通知进行消息触达。                                     | image.png       |

### 其他

如果在开发过程中，发现某些接口并没有开放，可以将需求提交给钉钉团队，我们收到您的需求后，会及时评估并给予回复。
