应用主页
Download
聚焦模式
字号
功能描述
Superapp 是小程序或小游戏的运行宿主，由 superapp 团队管理员或高级开发者在 superapp homepage 处创建，创建 superapp 后会生成配置文件，将配置文件下载并导入到代码工程中，完成小程序容器 SDK 集成。
角色和权限
功能 | 角色 | 超级管理员 | 平台管理员 | 应用管理员 | 应用高级开发者 | 应用开发者 | 应用运营人员 | 审核人员 |
应用主页 | 只读 | 只读 | ✓ | ✓ | ✓ | ✓ | ✓ |
创建、修改、删除应用 | - | - | ✓ | ✓ | - | - | - |
下载配置文件 | - | - | ✓ | ✓ | ✓ | - | - |
添加/修改包名 | - | - | ✓ | ✓ | - | - | - |
生成加密密钥 | - | - | ✓ | ✓ | - | - | - |
查看/复制加密密钥 | - | - | ✓ | ✓ | ✓ | - | - |
超级管理员/平台管理员：拥有应用主页模块的只读权限，拥有查看应用的权限，不能创建、修改、删除应用。
应用管理员/应用高级开发者：拥有应用主页模块的权限，拥有查看、创建、修改、删除应用、下载配置文件、添加/修改包名、生成与查看加密密钥的权限。
应用开发者：拥有应用主页模块的权限，拥有查看应用、下载配置文件、查看/复制加密密钥的权限。
应用运营人员/审核人员：拥有应用主页模块的权限，拥有查看应用的权限。
功能操作
1. 创建 superapp
填写信息：
字段 | 说明 | 是否必填 |
Superapp 名称 | 支持中文、大小写英文字母、数字、空格和部分特殊符号（"+"、"="、","、"."、"@"、"-"、"_"），3-64个字符。 | 是 |
Superapp 说明 | 此处可填写 superapp 的简介信息，主要用于团队内部查看。 | 否 |
Superapp icon | 支持上传 jpg、png 格式的方形图片、分辨率为128*128，图片大小在 2M 以内，若不上传 logo 图片，则使用系统默认 icon 图片。 | 否 |
Scheme | 不超过64个字符。设置 scheme 后，小程序（或小游戏）的二维码信息会包含 scheme，使用手机系统自带的扫码功能，可直接唤起 superapp 并打开小程序（或小游戏）。 | 否 |
2. 完成接入设置
2.1 配置获取方式说明
添加 Package name/Bundle ID 后，superapp 需要从控制台获取 SDK 初始化配置。当前提供两种获取方式，二选一即可，可在配置获取方式区域查看说明：
配置方式 | 适用场景 | 安全性 | SDK 版本要求 | 绑定关系 |
方式一：使用加密密钥（Encryption key） | 新版 SDK，推荐用于生产环境 | 较高（密钥下发由后台控制） | ≥ 2.3.8 | 与 Package name/Bundle ID 1:1 绑定 |
方式二：下载配置文件（Config file） | 旧版 SDK 或离线场景 | 配置文件为明文存储，需要自行保护 | ≥ 2.2.15 | 与应用维度绑定 |
说明：
两种方式只需任选其一进行 SDK 初始化，不需要同时使用。
推荐优先采用方式一：使用加密密钥，安全性更高且与包名一一绑定，便于权限控制与审计。
若所使用的 SDK 版本低于 2.3.8，请使用方式二：下载配置文件。
2.2 添加 Package name 和 Bundle ID
为 superapp 的 Android 端添加 Package name，为 iOS 端添加 Bundle ID。
添加 Package name/Bundle ID 时，需要选择和填写的字段有：
类型：类型选择后不允许修改，非生产类型的包名仅用于 superapp 测试版本使用，每个月有使用设备数量限制（最多500）。
Package name/Bundle ID：只能包含小写字母（a-z）、数字（0-9）、点（.）和连字符（-），不超过 255 个字符。建议采用反向域名表示法，例如 com.example.myapp。
下载地址：只能包含大小写字母（a-z）、数字（0-9）、点（.）、连字符（-）和斜杠（/），不超过 2048 个字符。
注意：
每个 superapp 只能添加1个生产 Package name/Bundle ID 和1个非生产的 Package name/Bundle ID。
Package name/Bundle ID 只能给真实的 superapp 使用，SAS SDK 会获取 superapp 的真实 Package name/Bundle ID 与控制台上填写的 Package name/Bundle ID 进行匹配，匹配不一致时，将无法使用 SDK 功能（无法打开小程序）。
2.3 使用加密密钥说明
每个 Package name/Bundle ID 都可生成唯一的加密密钥，SDK 使用该密钥进行初始化，密钥与包名 1:1 绑定，相比明文配置文件具有更高的安全性，推荐用于生产环境。
2.3.1 生成加密密钥
1. 在应用主页，先按照 2.2 添加好生产或非生产的 Package name/Bundle ID。
2. 在对应包名所在行，找到加密密钥」=字段：
若状态为未生成，单击生成密钥，系统会为该包名生成唯一密钥，生成成功后会展示掩码（如
A7B9***********************6Q8R0）并提示密钥生成成功。每个 Package name/Bundle ID 仅对应一份加密密钥，重复点击不会生成新的密钥。
2.3.2 查看与复制密钥
1. 密钥生成后，在加密密钥字段会展示掩码字符串以及获取密钥。
2. 单击获取密钥，系统会弹出密钥详情弹窗，展示完整密钥内容。
3. 单击弹窗内的复制，将密钥复制到剪贴板，提示复制成功。
4. 将复制到的密钥保存到您的后台服务，由后台下发给客户端，客户端在 SDK 初始化时使用该密钥即可完成接入。
注意：
加密密钥与 Package name/Bundle ID 1:1 绑定，不同包名对应不同密钥，互不通用。
该方式需要 SDK 版本 ≥ 2.3.8，低版本 SDK 请改用「方式二：下载配置文件」。
请勿将密钥硬编码在客户端代码或公共仓库中，建议由您的业务后台保管，并在客户端运行时按需下发。
仅「应用管理员/应用高级开发者」拥有「生成密钥」权限；「应用开发者」可查看与复制已有密钥；其他角色仅可只读查看是否已生成。
如怀疑密钥泄露，请联系应用管理员处理（如重新生成或更换包名），并同步更新业务后台所保管的密钥。
2.4 下载配置文件
添加 Package name/Bundle ID 后，superapp 开发者需要下载配置文件，将配置文件导入到 superapp 代码工程中。
操作步骤：
1. 找到配置获取方式中的方式二：下载配置文件。
2. 单击下载配置文件，下载 JSON 格式的配置文件。
3. 将配置文件放入应用工程目录（Android 端建议放入
assets 根目录；iOS 端将配置文件引入应用并添加到打包资源中）。4. SDK 初始化时根据配置文件初始化
TMFAppletConfig 对象，并使用 TMFAppletConfig 初始化小程序引擎。注意：
必须先添加 Package name/Bundle ID，否则下载配置文件会失败。
配置文件为明文存储，请妥善保管，不要上传到公开仓库。
该方式需要 SDK 版本 ≥ 2.2.15。
文档反馈