Publish an API service product

Integrate an API product

1. Log on to the ISV portal of Alibaba Cloud Marketplace.

2. In the navigation pane on the left, choose Product > Product Management.

3. Click Publish Product.

4. On the Integration Information page, follow the configuration wizard to enter the integration information.

   1. Enter the product integration information and click Next.

      Parameter	Description
      Select integration type	Click API/MCP.
      Product name	Enter a custom product name.
      Integration information	API type: For partners who only have API operations. No extra development is needed. Deploy and integrate the product as an API. Alibaba Cloud Marketplace supports automatic conversion to MCP. After conversion, the product can be sold in both API and MCP forms. MCP type: For partners who already have an MCP. Directly deploy and integrate the product as an MCP for commercial sale. MCP integration corresponds to shared and dedicated instances of Alibaba Cloud cloud-native gateways. For more information, see Partner enables AI Gateway for Alibaba Cloud Marketplace dedicated MCP instances. For more information about MCP listing, see Native MCP product listing operations.
      Select API group	This is the group that you created when you published the API in API Gateway. Click the region where the API group is located and select the target group.
      API access prefix	Enter the prefix for the API address. This prefix must be globally unique.
      Configure notifications for API production	If you select Yes, you must enter the API production notification address. After a user places an order on Alibaba Cloud Marketplace, the Marketplace calls the SPI interface that you developed to notify you of the user's transaction. This parameter works the same as the SPI interface for SaaS products. For more information, see SaaS product integration overview and SPI security token.

   2. Enter the basic product information and click Next.

      Parameter	Description
      Product image	Upload the product image to be displayed on the product page. You can upload an optional background image. The image must be a transparent PNG file, preferably 290px × 290px, and smaller than 7.5 MB. You can also upload a custom image. The image must have a 1:1 aspect ratio, preferably 310px × 310px, and be smaller than 7.5 MB.
      Product introduction	Enter a brief introduction for your product. This information is displayed on the product list page in Alibaba Cloud Marketplace. We recommend that you keep it under 300 characters.
      Product highlights	Describe the core features and services of the product that set it apart from similar products. The description must be within 1,000 characters.
      Product details	Provide a detailed description of the product's features, services, attributes, and usage flow. To include images in the details section, drag them directly into the rich text editor.
      (Optional) Product screenshots	You can upload up to six screenshots of the product in use. Each image must be smaller than 1 MB.
      (Optional) Product qualifications	You can upload relevant certificates for the product, such as intellectual property certificates, patent certificates, or special permits, to increase customer trust. You can upload up to six images. Each image must be smaller than 2 MB.
      (Optional) Customer use cases	You can add successful use cases for the product. This information is displayed on the product page.
      User guide	Upload the user guide for this product. The operations team will review it carefully. The guide must be a PDF file and smaller than 10 MB.
      After-sales support scope	Describe the level and hours of after-sales support that you provide.

   3. Enter the product business information and click Next.

      Parameter	Description
      Product category	Select the category for your product. Note You can select only from the marketplaces that you have joined. For API products, we recommend that you select Data and API. Otherwise, the review may be affected.
      (Optional) Custom tags	Set tags to help customers find your product quickly.
      Product search engine optimization information	Set keywords and a description related to the product to help search engines, such as Baidu, index your product.

   4. Enter the product sales information and click Next.

      API products support two sales models:

      • Pay-by-calls: Select this model if your API service is billed based on the number of API calls. This model is also known as the resource plan model.

        You must define the price and quota for the resource plan. The quota is the number of calls included in the plan. Alibaba Cloud Marketplace charges users for API calls based on the HTTP status code that is returned by your API operation.

        • A status code in the range of [200,300) indicates a successful call. Alibaba Cloud Marketplace charges for the call.

        • A status code in the range of [400,500) indicates a client-side fault, such as invalid client parameters. Alibaba Cloud Marketplace does not charge for the call.

        • A status code in the range of [500,600) indicates a server-side fault, such as the server being unavailable. Alibaba Cloud Marketplace does not charge for the call.

        Therefore, if you do not want to charge for an API call in a specific situation, you must ensure that the API returns an HTTP status code in the appropriate range.

      • Pay-as-you-go (post-paid): Select this model if your API service is billed based on the backend resources that are consumed by an API call, rather than the number of calls.

        You can configure resource plans for the pay-as-you-go model. If a customer purchases a resource plan, the quota in the plan is consumed first. After the quota is exhausted, the customer is charged at the pay-as-you-go rate.

        For pay-as-you-go billing, you must push the resource consumption information for user API calls to Alibaba Cloud Marketplace. Alibaba Cloud Marketplace then deducts the fees from the user's Alibaba Cloud account. The process is as follows:

        1. A user purchases the API product

           When a user purchases the API product, Alibaba Cloud Marketplace automatically generates a CaCloudMarketInstanceId. Each user is assigned a unique CaCloudMarketInstanceId. This ID is passed to you as a system parameter when the user calls the API.

        2. A user calls the API

           You must configure the CaCloudMarketInstanceId system parameter in API Gateway. When a user makes an API call, you can use this CaCloudMarketInstanceId to track the resource consumption of different users and aggregate the resource consumption data over a specific period.

           You must aggregate the resource consumption data by CaCloudMarketInstanceId and push the data to Alibaba Cloud Marketplace in the required format. Alibaba Cloud Marketplace then deducts the fees from the user's Alibaba Cloud account. For more information about the API operation for pushing pay-as-you-go metering data, see PushMeteringData.

        3. Overdue payment alerts

           Bills are typically generated within three hours after the end of a billing cycle. The system automatically deducts the billed amount from the user's Alibaba Cloud account balance. If the account balance is insufficient, the account has an overdue payment, and the system sends a notification by text message or email to the mobile phone number or email address that is registered with the account.

        4. After an overdue payment

           If the balance of an Alibaba Cloud account is insufficient to cover a bill, the account has an overdue payment. All pay-as-you-go API products that are associated with the account are suspended.

           When an API service is suspended due to an overdue payment, calls to the API service fail. We recommend that users add funds to their accounts to clear the overdue payment promptly to avoid service interruptions and potential business losses. After the user adds funds to the account and clears the overdue payment, the service is automatically restored.

           If a service is suspended due to an overdue payment, the user is considered to have voluntarily abandoned the API service, and calls to the API service will fail.

   5. Enter the user and product agreements and click Next.

      Parameter	Description
      EULA	Enter an End User License Agreement (EULA). This is a legal agreement between you and your customers. Customers must agree to this agreement before purchasing the product. You can use the EULA template provided by Alibaba Cloud Marketplace and modify it as required. You can also import a custom EULA template.
      Product Agreement	Enter a product agreement as promoted.