This document is designed for administrators and developers of the HiMarket AI open platform, providing detailed operation guides and best practices.

If you are an administrator, this document will guide you through the complete process from importing gateway instances, creating portals, to publishing API products. If you are a developer, this document will help you understand how to register an account, subscribe to API products, obtain call credentials, and initiate actual calls.

Through this guide, you can quickly master HiMarket’s core functions and achieve efficient management and convenient use of AI capabilities.

Table of Contents

• HiMarket Management Console
  • Register Administrator
  • Import Higress Instance
  • Create Portal
  • Create API Product
  • Link API
  • Write Usage Guide
  • Publish to Portal
• HiMarket Developer Portal
  • Access Portal
  • Register Developer
  • Browse and Subscribe to API Products
  • Create Consumer
  • HiChat

---

HiMarket Management Console

The HiMarket management console is designed for administrators and operators to manage AI resources, create portals, publish API products, etc.

Register Administrator

When accessing the HiMarket management console for the first time, you need to register an administrator account.

Operation Steps:

1. Access the management console address: http://localhost:5174 (using local development environment as an example)
2. Click the “Register” button
3. Fill in administrator information:
   • Username
   • Password
4. Click “Initialize” to complete account creation
5. Log in to the management console using the registered account

---

Import Higress Instance

Before starting to create API Products, you need to import a Higress gateway instance as the underlying gateway for AI resources.

Operation Steps:

1. Log in to the management console
2. Navigate to [Instance Management] → [Gateway Instances]
3. Click the [Import Gateway Instance] button
4. Select [Higress Gateway]
5. Fill in Higress instance information:
   • Console Address: Higress console address (e.g., http://demo.higress.io)
   • Username: Higress console username (e.g., admin)
   • Password: Higress console password (e.g., admin)
   • Gateway Address: Higress gateway service address (e.g., http://gateway.higress.io), MCP Server and Model use domain names for access by default. If no domain is configured, the Gateway address is used
6. Click [Import]

Notes:

• Supports importing multiple Higress instances
• After import, you can view and manage them in the instance list

---

Create Portal

A Portal is a site for external developers. Administrators can create multiple portals, each with independent configuration and API products.

Operation Steps:

1. Navigate to the [Portal] menu
2. Click the [Create Portal] button
3. Fill in basic portal information:
   • Portal Name: e.g., himarket-demo
   • Portal Description: Brief description of portal purpose
4. Click [Confirm]

Portal Configuration Description:

After creating a portal, click the portal card to enter the detailed configuration page, which mainly includes the following functions:

1. Overview

• Portal basic information: name, description, login method, approval policy, etc.
• Statistics:
  • Number of published API products
  • Number of registered developers

2. Products (Published API Products)

• Manage API products published in the current portal
• View product details
• Remove or update published products

3. Developers (Developer Management)

• View and manage developers registered in this portal
• Approve developer registration applications
• Manage Consumers associated with developers
• View developer subscription status

4. Security (Security Settings)

User login configuration:

• Username/Password Login: Traditional username and password method (enabled by default)
• OIDC Login: Supports third-party identity authentication (such as enterprise SSO)

Approval process configuration:

• Developer Registration Approval: Choose whether to automatically approve developer registration applications
  • Automatic Approval: Developer registration takes effect immediately
  • Manual Approval: Requires administrator approval in the backend before use
• API Product Subscription Approval: Choose whether to automatically approve subscription applications
  • Automatic Approval: Developer subscription requests take effect immediately
  • Manual Approval: Requires administrator approval before calling API Products

5. Domain (Domain Management)

• The system automatically assigns a default domain for each portal
• Additional custom domains can be bound (e.g., binding localhost for local development)

Notes:

• Domains require self-configuration of DNS resolution or hosts file to point to the himarket-frontend service
• Portals use multi-tenant design, identifying different portal instances through domains
• For local development, it’s recommended to bind the localhost domain for easy testing
• For production environments, it’s recommended to configure real domain names and DNS resolution

---

Create API Product

API Product is a core concept of HiMarket. It encapsulates underlying AI capabilities (such as MCP Server, Model, Agent) into standardized API products.

Operation Steps:

1. Navigate to the [API Products] menu
2. Click the [Create API Product] button
3. Fill in product information:
   • Product Name: e.g., demo-api
   • Product Type: Select product type (MCP Server, Model API, Agent API, etc.)
   • Product Description: Brief description of product features and purpose
   • Product Category: Select product category, categories can be used for classification and filtering, supports custom categories
   • Product Icon: Select product icon, can use URL link or upload local file
4. Special Note: Model API type products can configure model parameters, such as Model name, Max Tokens, Temperature, whether to support internet search, etc. Model parameters are used for debugging models in the HiMarket frontend. If missing, it may cause model call failures
5. Click [Confirm]

6. After successful creation, enter the product details page

Product Status Description:

Newly created API Products have an initial status of “Pending Configuration”. The following operations need to be completed before publishing:

1. Link API: Associate the product with actual API resources
2. Configure Usage Guide: Write product usage documentation
3. Publish to Portal: Publish the product to a specified portal for developer subscription

---

Link API

After creating an API Product, you need to associate it with actual API resources, establishing a mapping relationship between the product and underlying services.

Operation Steps:

1. Enter the API Product details page
2. Click the [Link API] tab
3. Select API resource type:
   • MCP Server: From Higress or AI Gateway (Enterprise Higress) MCP service
   • Model API: From Higress or AI Gateway model service
   • Agent API: From AI Gateway Agent application
4. Select the API resource to link from the list. For example, for Model API, link AI routes on Higress
5. Click [Link]

7. After successful linking, the API Product status changes to “Pending Release”. At this point, the API Product can be published to the Portal. The Link API tab will display API configuration information

---

Write Usage Guide

Write detailed usage guides for API Products to help developers quickly understand and use APIs.

Operation Steps:

1. Enter the API Product details page
2. Click the [Usage Guide] tab
3. Use the Markdown editor to write usage documentation:
   • API Product Introduction: Features and use cases of the API product
   • Authentication Method: How to obtain and use credentials
   • Request Examples: Provide complete request example code
   • Response Examples: Show API return data format
   • Error Code Description: List common error codes and handling methods
   • Best Practices: Usage recommendations and precautions
4. Supports real-time preview to ensure correct formatting
5. Click [Save]

---

Publish to Portal

When the API Product configuration is complete, it can be published to specified portals for developer use.

Operation Steps:

1. Enter the API Product details page
2. Confirm the product status is “Pending Release” (API linking completed)
3. Click the [Publish to Portal] button
4. Select target portal:
   • Select one or more portals from the portal list
   • Can be published to multiple portals simultaneously
5. Click [Publish]

After Publishing:

• The product will be immediately displayed in the portal
• Developers can browse product details and usage guides
• Developers can apply to subscribe to the product
• Administrators can view subscription and call status in the backend

At this point, the complete process of an API Product from creation to publication is complete!

---

HiMarket Developer Portal

The developer portal is a self-service platform for external developers, where developers can register, browse API products, apply for subscriptions, and initiate calls.

Access Portal

HiMarket portals use multi-tenant design, identifying different portal instances through domain names.

Access Methods:

1. Use Default Domain:
   • Each portal is automatically assigned a default domain
   • For example: portal-68ac4564bdb292ee9261ff4a.api.portal.local
   • Requires DNS resolution or hosts file configuration to point the domain to the himarket-frontend service
2. Use Custom Domain:
   • Custom domain bound by administrators in the backend
   • For example, localhost bound for local development
   • Access: http://localhost:5173
3. Use himarket-frontend Service IP:
   • Using the himarket-frontend service IP will access the “Default Portal”, which is the first portal created
   • For local development environment, access http://127.0.0.1:5173

---

Register Developer

Developers need to register an account in the portal first to browse and subscribe to API products.

Registration Steps:

1. Access the portal homepage
2. Click the [Register] button
3. Fill in developer information:
   • Username: Unique developer identifier
   • Password: Set login password
4. Click [Register] to submit application

Registration Approval:

The status after registration depends on the portal configuration:

• Automatic Approval Mode: Registration takes effect immediately, can log in directly
• Manual Approval Mode: Registration requires administrator approval
  • Cannot log in to portal before approval
  • Administrators approve in the backend [Developers] menu

After approval, you can log in to the portal

Notes:

• Developer accounts for each portal are independent
• Need to register separately for different portals

---

Browse and Subscribe to API Products

After registration and login, developers can browse API products in the portal and apply for subscriptions.

Browse API Products:

1. Log in to the developer portal
2. Navigate to [Models], [MCP], [Agents], and other product pages
3. Browse product list:
   • View product names, descriptions, and versions
   • Filter and search for products of interest
4. Click product card to view details:
   • Product feature introduction
   • API Product usage guide
   • Call example code (if available)
   • Pricing information (if available)

---

Create Consumer

In HiMarket’s design:

• Developer: Represents user identity, used for login and management
• Consumer: Represents call credentials, used for API Product authentication

One Developer can create multiple Consumers for different application scenarios (such as development environment, test environment, production environment). Each Developer is automatically assigned a Consumer after registration and supports creating new Consumers.

Creation Steps:

1. Log in to the developer portal
2. Click the avatar in the upper right corner and navigate to [Consumer Management]

3. Click the [Add Consumer] button
4. Fill in consumer information:
   • Consumer Name: Used to identify this consumer (e.g., my-app-prod)
   • Description: Brief explanation of purpose (e.g., production environment application)
5. Click [Submit]

After Successful Creation:

• The system will generate a set of credentials (such as API Key, Secret)
• You can manage and delete created consumers in the list

Apply for Product Subscription:

After creating a consumer, you can use the consumer to subscribe to API products:

1. Select the API product to subscribe to
2. Click the [Subscribe] button on the product details page
3. Select the Consumer to use
4. Click [Confirm Subscription]

Subscription Approval:

• Automatic Approval: Takes effect immediately after submission, can directly call API Product
• Manual Approval: Need to wait for administrator approval

Description:

• Subscription status can be viewed in the [Subscription List] of Consumer details
• After successful subscription, you can use the Consumer’s credentials to call the corresponding API Product
• You can cancel subscription at any time

---

HiChat

HiMarket provides the HiChat AI Innovation Center for quickly applying AI resources, such as conversing with models and calling MCP Servers with models.

Call Models and MCP:

1. Log in to the developer portal
2. Navigate to the [HiChat] page

3. Select the model product to test, you can converse with this model, and during the conversation, you can choose to combine with MCP Server
4. Note:
   • Models and MCP Servers need to be subscribed to before they can be accessed normally. HiMarket HiChat uses the Developer’s default Consumer by default. You need to use the default Consumer to subscribe to corresponding API Products
   • Developers can configure the default Consumer in the [Consumer Management] page
5. Operation Example:
   • Select model and MCP Server

• Specify and subscribe to MCP Server. Quick subscription will use the default Consumer to execute subscription operations

• Converse with model

At this point, you have successfully completed the full process experience of the HiMarket platform! Thank you for choosing HiMarket! We look forward to seeing you build excellent applications with it.