Developer Portal Branding, Homepage, and Customer Service

This article modifies the default appearance of the API Platform to Zhishu Cloud and configures customer service, legal, menu, and homepage banner.

Completion Effect

When accessing the developer portal, the navigation, footer, support page, browser title, and homepage content all use the Zhishu Cloud branding.

Real Case: Zhishu Cloud Developer Portal at platform.zhishuyun.com

Preparation Before Starting

  • An API Platform Site has been created;
  • Company, copyright, and record information;
  • Customer service, documentation, terms of service, and privacy policy links;
  • Homepage main title, description, and button target;
  • Logo and Favicon have been uploaded.

Step 1: Open "Branding and Customer Service"

  1. Go to the Sites in the Platform console;
  2. Click on the Zhishu Cloud Site;
  3. Click on Branding and Customer Service at the top;
  4. Fill in the company Zhishu Cloud Technology;
  5. Fill in the copyright and record information;
  6. Enable "Hide Powered by" and "Hide API Code Entry" as needed;
  7. Do not save incorrect or inaccessible links for now.

Upper section of Branding and Customer Service: Configure company, copyright, record, and hide platform traces

Fill in the following:

  • Support: your customer service or ticket page;
  • Docs: developer documentation homepage.

Terms of service and privacy policy are maintained separately on the "Legal" tab. Links can be complete https:// addresses; internal pages can also use the root relative paths supported by the console. After saving, click each link from an incognito window.

Step 3: Add Customer Service Channels

Click "Add Contact Method" and fill in each record:

  • Type: lowercase English identifier, such as email, wechat, discord;
  • Display Name: such as "Zhishu Cloud Technical Support";
  • Contact Value: email, account, or group number;
  • Redirect Link: must be an accessible HTTPS address;
  • QR Code: optional, fill in the public image URL.

At least one real responsive channel must be retained. Empty contact methods will not automatically revert to platform customer service.

Lower section of Branding and Customer Service: Configure help center, documentation site, and own customer service channels

  1. Open "Legal" and confirm that the terms and privacy policy belong to Zhishu Cloud;
  2. Open "Menu" and hide default entries that you do not want customers to see;
  3. Use short titles and clear links when adding menus;
  4. Check desktop navigation and mobile menu in sequence.

Terms of Service and Privacy: Maintain formal legal content visible to customers separately

Menu: Decide which entries customers see in the navigation bar and their order

  1. Open Banners;
  2. Create a new Banner;
  3. Fill in the title, summary, button text, and target link;
  4. Set sorting, enable status, and effective time;
  5. If targeting multilingual customers, fill in the corresponding titles separately;
  6. Save and return to the homepage to check.

Banner: Create, sort, and enable/disable homepage banners on the same page

Banners should guide customers to real existing services or documents, and do not retain platform activities unrelated to your brand.

Step 6: Acceptance of SEO First Screen

  1. Open the preview site in an incognito window;
  2. Check the browser title, description, and Favicon;
  3. View the page source code, search for <title>, description, og:title, og:image, and favicon;
  4. Use search engines or social crawlers' User-Agent to request the homepage;
  5. Check if the canonical and OG URL use the current domain name.

The title, description, canonical, and OG of the Platform custom domain name have supported server-side injection; however, raw HTML and favicon should still be accepted site by site, and should not rely solely on the results after browser hydration.

Success Indicators

  • The homepage, navigation, footer, and support page are all Zhishu Cloud;
  • Customer service, terms, and privacy links are accessible from an unlogged window;
  • Banners display in the correct order and redirect;
  • Browser and crawler first screen title, description, OG, and canonical are correct;
  • Favicon points to your icon in both the browser and original HTML.

Frequently Asked Questions

Save Button Unavailable

Check the link format and customer service type. The customer service type should start with a lowercase letter, and the link and QR code need to be complete HTTP(S) addresses.

Old Customer Service Still Displayed After Deleting

Refresh the Site configuration and check with an incognito window. An empty list means customer service will not be displayed and should not revert to the default platform customer service.

Browser Correct but Crawler Incorrect

Save the original response headers and HTML, record the User-Agent and time, then contact support; this is a failure of first screen injection acceptance.

Next Article

Continue configuring Service Directory, Pricing, and Development Documentation.