Service Directory, Pricing, and Development Documentation
This article allows the Zhishu Cloud developer portal to only display the services you are ready to sell, ensuring that prices, documentation, and code examples are consistent with each other.
¶ Completion Effect
Customers can access services from the homepage, see the correct prices, and complete calls along the documentation; services that are not for sale and irrelevant documentation will not appear in the navigation.
¶ Preparation Before Starting
- Select the first batch of 3 to 10 services;
- Default markup of 10%;
- List services that require separate pricing;
- Prepare a one-sentence summary for each service;
- Decide which documentation directories should be hidden.
¶ Step 1: Set Site-Wide Pricing
- Go to the "Pricing" section of the Site details;
- Set the default markup to
10%; - Confirm the currency and applicable scope;
- Save;
- Open the preview site pricing page and record the customer prices for three services.
¶ Step 2: Organize Service Directory
- Open "Services";
- Disable services that are not ready for sale;
- Set display titles and summaries for promoted services;
- Adjust the order according to customer usage;
- Set separate markups for special services;
- After saving, check the service page from an incognito window.
Single service markups take precedence over the site-wide 10%. Hidden services only change the site directory and do not equate to interface permission control; the limits and deactivation of customer credentials need to be managed in the delivery process.
¶ Step 3: Organize Documentation Directory
- Open "Documentation";
- Find the root directory of the documentation corresponding to the services not for sale;
- Hide the entire irrelevant directory;
- Modify the documentation titles and summaries visible to customers;
- Adjust the order to place "Quick Start" before interface details;
- Retain common descriptions such as authentication, error handling, billing, and task polling.
Do not just hide the parent node while leaving isolated child documents. After saving, expand the site navigation layer by layer to confirm that the directory is a complete and understandable tree.
¶ Step 4: Walk Through Documentation for Each Service
For each service ready for sale, perform:
- Click "View Documentation" from the service page;
- Find the authentication description;
- Copy the minimum request example;
- Check the model name, required parameters, and return fields;
- Verify whether the asynchronous task explains both creation and query steps;
- Cross-check the pricing page with the actual billing units.
¶ Step 5: Check Multilingual Support
If the site offers English or other languages:
- Switch languages;
- Check service titles, summaries, and documentation titles;
- Check if untranslated key names appear in the navigation;
- Confirm that the example code itself has not been incorrectly translated.
¶ Success Indicators
- The service directory only displays services ready for sale;
- Default 10% and single service coverage meet expectations;
- Each service can access the correct documentation;
- Irrelevant directories are hidden, with no isolated documents;
- Authentication, parameters, polling, error, and billing descriptions are complete;
- Multilingual titles do not contain placeholders or incorrect branding.
¶ Frequently Asked Questions
¶ Services are hidden, but documentation is still there
Services and documentation are two independent display configurations. Go back to "Documentation" to hide the corresponding directory separately.
¶ Prices differ from expectations
Check single service coverage, currency, and whether the customer hit other packages. First, compare using the same unauthenticated page, then check actual records with a test account.
¶ API Host in the documentation still shows the default domain name
The API Host will use a custom domain name after successful verification of the API request domain name. Complete the next article on domain configuration before returning to verify the code examples.
¶ Next Article
Continue binding Page Domain and API Domain.
