Configuration Management
Feature overview
Configure backend service domains to manage the domains your superapp uses when communicating with backend servers. Multiple domains enable independent endpoints for different environments (development, testing, production) or business scenarios.
Roles and permissions
Feature | Role | Super admin | Platform admin | Superapp admin | Senior superapp developer |
Configuration management | Read-only | Read-only | ✓ | ✓ |
Super admin/Platform admin: Has read-only permissions for the configuration management module.
Superapp admin/Senior superapp developer: Has permission to add and modify configurations.
Feature description
Entry point
Superapp management → Configuration management → Backend service configuration
View domain configuration
On the configuration management page, you can view all configured backend service domains. Each domain is displayed as a card with the following details:
Field | Description |
SecretKey | Used for authentication and shown in masked format. No character restrictions, but input length must be exactly 16, 24, or 32 characters. |
Domain | Backend service domain URL. Only supports lowercase letters (a-z), numbers (0-9), dots (.), and hyphens (-), up to 253 characters. |
Notes | Supplementary information about the backend service domain. |
Default flag | Cards marked “Default” represent the currently active default domain. If the superapp doesn’t specify a backend, it automatically uses the default configuration. |
Add a new domain
Directions:
1. Click the dashed card with a "+" on the page.
2. Fill in the configuration info in the pop-up dialog:
SecretKey(Required): Used for authentication, shown masked. No character restrictions, but input length must be exactly 16, 24, or 32 characters.
Domain name(Required): Enter the full backend service domain, such as
https://api.example.com . Only supports lowercase letters (a-z), numbers (0-9), dots (.), and hyphens (-), up to 253 characters.Description(Optional): Enter a recognizable note, like "production environment" or "testing environment".
3. Click "Confirm" to save the configuration.
Edit domain
Directions:
1. At the top-right corner of the target configuration card, click the action icon (three dots).
2. Select "Edit" from the dropdown menu.
3. Modify the configuration details in the pop-up edit dialog.
4. Click "Confirm" .
5. In the confirmation pop-up, click "Confirm" to finalize changes.
Note:
The edit operation triggers a confirmation prompt to prevent accidental changes.
Set default configuration
Directions:
1. At the top-right corner of the target configuration card, click the action icon (three dots).
2. Select “Set as default” from the drop-down menu
3. In the confirmation pop-up, click "Confirm" to complete the setting.
Notes:
Superapp connects to the default configuration only when no backend is specified. You can specify which configuration to use.
Only one default configuration can be active at a time.
If a configuration is already the default, the "Set as default" option is disabled (grayed out).
Example scenarios
Scenario 1: Multi-environment switching
Configure different backend service domain names for development, testing, and production environments:
Configuration name | Domain | Purpose |
Development environment | https://dev-api.example.com | Local development and debugging |
Testing environment | https://test-api.example.com | QA testing and validation |
Production environment | https://api.example.com | Official release (set as default) |
Scenario 2: Canary release
During a canary release of a new version, configure the domain for the canary environment to facilitate quick switching:
Configuration name | Domain |
Production service | https://api.example.com |
Canary service | https://canary-api.example.com |
FAQs
Q1: When does the default configuration update take effect?
It takes effect immediately. New requests will be sent to the updated domain. There may be a delay of several minutes.
Q2: Can I delete the configuration?
Deleting configurations is not supported in the current version. To remove a configuration, rename it to indicate it is no longer in use.
Q3: Is there a limit to the number of domain configurations?
Up to three backend service domain configurations are supported.
Help and Support
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback