All Products
Search
Document Center

Publish API Products to Marketplace

Last Updated: Dec 29, 2020

To sell your API products in Alibaba Cloud Marketplace, you must publish them on Alibaba Cloud Marketplace. This topic describes how to publish an API product on Alibaba Cloud Marketplace.

Contents

Prerequisites

Procedure

Prerequisites

Your API product is published to API Gateway. For more information, see Publish API products on API Gateway.

Procedure

1. Log on to the Alibaba Cloud Partner Network Console, and click Marketplace Seller Portal.

2. In the left-side navigation pane, choose Listing >Product Manager.

3. Click Create Product.

4. On the Access Information page, enter the product information in the configuration wizard.

i. Enter the access information and click Next.

Parameter

Description

Choose Your Product Type

Select API Service.

Product Name

Enter a custom product name.

Select API Group

This group is the API group that you used when you published the API product to API Gateway. Click the region where the API Group resides and select the API group.

API Prefix

Enter the API endpoint prefix. Make sure that the prefix is globally unique.

Configure Production Notification

If you select Yes, you must enter the URL that is used to receive production notifications. After a customer places an order in Alibaba Cloud Marketplace, the service provider interface (SPI) is called to notify you of the transaction. The parameter works in the same way as the SPI of SaaS products. For more information, see SPI security scheme.

ii. Enter the basic information and click Next.

Parameter

Description

Product Logo

Upload the product images that you want to show on the product list page and product details page. The recommended image size is 200 × 150 pixels.

Short Description

Enter the short description of your product. This description appears on the product list page in Alibaba Cloud Marketplace. We recommend that you enter no more than 200 characters.

Product Highlights

Enter the detailed description of your product. This description appears on the top of the product details page. We recommend that you describe your product as detailed as possible.

Product Description

Describe your product in detail with rich text. If you want to use an image in the product description, drag the image to the rich text editor.

Product Screenshot

Optional. Upload snapshots of your product for the customers' reference.

Product Certifications

Optional. Upload certificates of the product, such as the intellectual property certificate, patent certificate, and special certificates, to increase customers' trust in the product.

Customer Stories

Optional. Enter success stories about the product. These stories appear on the product details page.

User Guide

Upload the documentation of your product. The operational staff will check the user guide when they review your product. The user guide must be in PDF format and cannot exceed 10 MB.

Support Offered

Enter after-sales support information, such as the support that you can provide and the time period during which the support is available.

iii. Enter the business information and click Next.

Parameter

Description

Product Category

Select the category of your product.

Custom Tag

Optional. Add a tag to the product so that customers can find the product based on the tag with ease.

SEO for Your Product

Specify search keywords and description for the product. This increases the visibility of the product in search results of search engines such as Google.

iv.Enter the salesinformation and click Next.

Currently, API productsare billed by package.

  • Package mode: In this mode, you can offer your API product in theform of packages.

You must specify the price and quota of packages. The quota is the number of calls that packages provide. Alibaba Cloud Marketplace calculates the number of API calls based on HTTP status codes that the API calls return.

  • HTTP status codes that range from 200 to 299 indicate successful API calls. API call that return any codes in this range is considered as valid calls and the package quota is deducted.

  • HTTP status codes that range from 400 to 500 indicate client errors, such as an invalid client parameter. API call that return any codes in this range is considered as invalid call and the package quota is not deducted.

  • HTTP status codes that range from 500 to 599 indicate server errors, such as server unavailability. API call that return any codes in this range is considered as invalid call and the package quota is not deducted.

If your API product is free in some cases, you must adjust the HTTP status code to a proper range.

v. Enter the product agreement and click Next.

Parameter

Description

EULA

End User License Agreement (EULA) is a legal agreement between you and your customers. Customers must agree to this agreement before they purchase the product. You can use the EULA template that Alibaba Cloud Marketplace provides and modify the template as required. You can also import a custom EULA template.