Note:
This guide is intended to provide enterprises with a code-free access experience.
1. Roles and permissions
1.1. User type
Super admin
Description: The highest level of permissions, with only one super admin allowed.
Permissions: Full access to platform management, team management, user management, operations management, and monitoring modules. Read-only access to app and mini program management modules.
Platform admin
Description: Created by the super admin (multiple allowed), equivalent to the management level within the enterprise.
Permissions: Inherits super admin permissions.
Member
Overview: Created by the super admin, platform admin, or team admin, or can self-register.
Permissions: Can modify user information and password if not in a team. Gains team-specific permissions after joining.
1.2. Preset team roles
The product provides preset roles, including team admin, member admin, developer, operator, and approver, to meet actual business control needs.
App team roles and permissions
|
Team member management | ✓ | ✓ | - | - | - | - |
Superapp management | ✓ | - | ✓ | - | - | - |
App integration | ✓ | - | ✓ | ✓ | - | - |
Mini program release approval | ✓ | - | - | - | - | ✓ |
Sensitive API management | ✓ | - | ✓ | - | - | - |
Sensitive API call approval | ✓ | - | - | - | - | ✓ |
Data dashboard | ✓ | - | ✓ | - | ✓ | - |
User feedback | ✓ | - | ✓ | ✓ | ✓ | - |
User complaints | ✓ | - | - | - | ✓ | - |
Ad unit approval | ✓ | - | - | - | - | ✓ |
App team roles:
Superapp administrator: The only admin with full permissions for the app team.
Superapp member manager: Responsible for managing app team members, with the permissions to modify team names, and manage team members and roles.
Superapp senior developer: Typically the technical leader of the app team, with permissions for management, development, viewing operational data, and monitoring data.
Superapp developer: The developer of the superapp, with permissions for development and viewing user feedback and feedback logs.
Superapp operator: Responsible for summarizing and analyzing user feedback and mini program data within the superapp, providing data support for product experience improvements.
Review staff: Responsible for the approval process between mini programs and the superapp, including mini program release approval, sensitive API call approval,ad unit approval, etc.
Mini program team roles and permissions
|
Team member management | ✓ | ✓ | - | - | - | - |
Mini program management | ✓ | - | ✓ | - | - | - |
Mini program development configuration | ✓ | - | ✓ | - | - | - |
Real-time logs | ✓ | - | ✓ | ✓ | - | - |
Mini program development and IDE usage | ✓ | - | ✓ | ✓ | - | - |
Mini program experience | ✓ | - | ✓ | ✓ | ✓ | ✓ |
Submit the mini program for approval | ✓ | - | ✓ | - | - | ✓ |
Mini program release | ✓ | - | ✓ | - | - | - |
Data dashboard | ✓ | - | ✓ | ✓ | ✓ | - |
User feedback | ✓ | - | ✓ | ✓ | ✓ | - |
Mini program team roles:
Mini program administrator: The only admin with full permissions for the mini program team.
Mini program member manager: Responsible for managing mini program team members, with the permissions to modify team names, and manage team members and roles.
Mini program senior developer: Typically the technical leader of the mini program team, with permissions for management, development, IDE, viewing operational data.
Mini program developer: The developer of the mini program, with permissions for development, IDE and viewing user feedback and feedback logs.
Mini program operator: Responsible for summarizing and analyzing user feedback and mini program data, providing data support for product experience improvements.
Mini program approver: Responsible for the approval process between the mini program and apps, including experiencing the mini program, approving the mini program release, and releasing the mini program, etc.
2. Integration process
The product provides enterprises with the technical capabilities for developing, testing, releasing, operating, and integrating mini programs into host applications. The diagram below illustrates the entire process from activating the product to releasing the mini program within the host application.
The following is a quick start guide for the product.
3. User and team management
3.1. Preparations
Please make sure you have the login link, admin account and password. Log in to the console with the admin account.
3.2. User management
Super admin and platform admin can go to User management > User list in the left menu of the console, and click Create user to create a sub-account. To create a new user, you need to fill in or select the following information: Username: Used for internal identification and search within the platform.
Login account: The account the user will use to log in.
Login password: The password the user will use to log in. This can be auto-generated by the platform or manually entered by the admin.
Account type: You can designate the user as either a platform admin or a member. Platform admins cannot join a team or inherit super admin permissions; members can join teams later and gain permissions based on their team roles.
3.3. Team management
Teams help organize and manage groups of users, mini programs, and superapps. Enterprises can use teams to efficiently manage personnel and resources across different business lines.
Data will be isolated between different teams, but mini program across teams can be associated with superapps. When a team is deleted, the enterprise super admin can also transfer the team resources to another team. Both super admins and platform admins can create, edit, and delete teams.
Members can join teams to gain role-based access to resources. Super admins, platform admins, and team admins can manage team members by adding existing members or creating new ones.
Create a team
The super admin and platform admin can create new teams, set team admins, and manage team permissions. Create team - Superapp team
You need to have a superapp team before you can create superapps under the team.
Click Create team, enter the team name in the pop-up window, select one user from the user list or create a new user, and set the user as the team admin.
Tick Superapp management option for team permissions and click Confirm to create a superapp team.
Create team - Mini program team
For SAS v2.0.4 and later versions, a mini program team needs to be bound to a superapp team, and a mini program team can only be bound to one superapp team.
Click Create team, enter the team name in the pop-up window, select one user from the user list or create a new user, and set the user as the team admin.
Tick Mini program management option for team permissions and click Confirm to create a mini program team.
In SAS v2.2.14, the mini program team expiration time management feature is available. When creating a mini program team, you can set the expiration time for the mini program (optional).
After the expiration time is set, the system will send an email to notify the mini program team admin, super admin, and platform admin 7 days before the mini program team expires. Upon the expiration, members of the mini program team will not be able to log in to the console and IDE.
Note:
The super admin and the platform admin can manually deactivate mini program teams.
Upon the expiration, the super admin or platform admin can set a new expiration time for the mini program team to re-activate the team.
Superapp team member management
Superapp administrator and superapp member manager can manage team members. Click Team management > Member management in the left menu of the console, and click Create member to create a new member and add the member to the team. Users created in this way can only be members. Superapp administrator and member manager still need to fill in the username, login account and password, team name, and role. Mini program team member management
Mini program administrator and mini program member manager can manage team members. Click Team management > Member management in the left menu of the console, and click Create member to create a new member and add the member to the team. Users created in this way can only be members. Admins still need to fill in the username, login account and password, team name, and role.
4. Superapp management
4.1. Create a superapp
Superapp is the host environment for running mini programs or mini games. It is created by superapp administrator or superapp senior developers on the Superapp Homepage. After creating a superapp, a configuration file is generated. Download the configuration file and import it into the code project to complete the mini program container SDK integration. Required information:
Superapp name: Supports 3-64 characters including a-z, A-Z, 0-9, spaces and some special symbols ("+", "=", ",", ".", "@", "-", "_").
Optional information:
Superapp description: Brief introduction of the superapp, primarily for internal reference.
Superapp icon: Supports uploading square images in .jpg or .png format, with a resolution of 128 × 128 and a file size under 2 MB. If the icon is not uploaded, the system default icon will be used.
4.2. Complete the integration
4.2.1 Add the package name or bundle ID
Add the package name for Android and bundle ID for iOS.
The following fields need to be filled in when adding the package name/bundle ID:
Type: Once selected, the type cannot be changed. Package names for non-production types are only used for superapp test versions and have a monthly device usage limit (up to 500 devices).
Package name/bundle ID: Only supports lowercase letters (a-z), numbers (0-9), dots (.), and hyphens (-), up to 255 characters. It is recommended to use reverse domain name notation, such as com.example.myapp.
Download URL: Only supports lowercase letters (a-z), numbers (0-9), dots (.), hyphens (-), and slashes (/), up to 2,048 characters.
Scheme: Only supports lowercase letters and numbers, up to 64 characters. Once the scheme is configured, the QR code of the mini program (or mini game) will include this scheme. Using the phone system’s built-in scanning function, users can directly launch superapp and open the mini program (or mini game).
Note:
Only one production package name/bundle ID and one non-production package name/bundle ID can be added for a superapp.
Package name/bundle ID can only be used for genuine superapps. The SAS SDK will verify the real package name/bundle ID of the superapp against the one entered in the console. If they do not match, the SDK features will be unavailable (the mini program cannot be opened).
4.2.2 Download the configuration file
After adding the package name/bundle ID, superapp developers need to download the configuration file and import it into the superapp code project.
4.3. Mini program release approval
Note:
Releasing a new mini program version requires approval from the superapp administrator or review staff.
After the mini program team submits the mini program for approval, the superapp administrator or review staff will receive the approval notice in Release approval - Pending and confirm the approval. Click Approve in the Operation column to check the submitted version release request. Scan the QR code using the superapp (after completing the SDK integration process) to preview the features of the mini program or mini game, and decide whether to approve or reject the request.
After approval, the mini program team also needs to release the mini program in Mini program management - Version management.
5. Mini program creation and release
5.1. Mini program creation
1. The mini program administrator and mini program senior developer can go to Mini program list, click Create mini program and configure the required information. 2. Click Next to download the latest IDE version on demand in the console, or click the following link to download.
3. Open the IDE installation file TCSAS-Devtools_x64.exe and click the desktop icon to enter the IDE login page.
5.2. Mini program code upload
1. After completing the steps of integrating the superapp, creating the mini program, and binding the mini program to the superapp, developers can create a new project in the IDE (note that AppID here is the mini program ID, and you can drop down to select the mini program that has been created in the console without manual input).
2. After entering the IDE editor, you can directly upload the mini program.
5.3. Mini program release
After approval, in Version management, a prompt will appear to let you know the new version can be released. Personnel with release permissions can then proceed with the release. 6. Mini program preview on real device (Important)
Enterprise developers can download the official demo that we provided, compile and install it using the configuration files mentioned in the Create a Superapp section, and then preview the mini program. 6.1. Android
1. Replace the configuration file in the project with those downloaded in section 4.2 Download the configuration file in . 2. Replace the built-in mini program list with the bound mini program IDs for quick access in the DemoApp.
3. Run DemoApp on a real device, scan the code, search or open the built-in mini program.
6.2. iOS
Note:
Ensure the Bundle ID matches the one configured earlier.
1. Replace the configuration file in the project with those downloaded in section 4.2 2. Replace the built-in mini program list with the bound mini program IDs for quick access in the DemoApp.
3. Run DemoApp on a real device, scan the code, search or open the built-in mini program.