全部产品
云市场

API类商品接入说明

更新时间:2019-12-19 16:03:52

前提条件

发布API商品,包括以下前提条件:

  • 服务商需要先入住API集市。
  • 需要将您的API服务部署在阿里云API网关,API服务部署在API的过程请参考:开放API快速入门

商品上架

1. 接入信息

API类商品的接入信息除了商品名称外,主要要填写

  • API分组信息:分组信息来自您在API网关开放的API。

API接入信息

您在API网关开放的所有API会按region展示并供您选择,选好API网关后,需要指定一个API地址前缀,注意该前缀全局唯一,如果您设定的名称已被占用,系统会标红并不会被通过。

  • 接入信息:非必填,该接入信息与SaaS类商品的SPI接口作用相同(详见:SPI接入文档),如果您配置了SPI地址,客户在云市场下单后,云市场会调用您开发的SPI接口,通知您用户的交易行为。

2. 商品基础信息

a) 商品图片:请上传商品列表页面和商品详情页面展示的商品图片。推荐图片大小为160*120像素。

b) 商品简介:请填写您的商品简介,此信息将在云市场的商品列表页面进行展示,建议字数控制在100字以内。

c) 商品亮点:请填写您商品的详细介绍信息,此信息将在商品详情页面的头部进行展示,建议尽量详情得描述您的商品。

d) 商品详情:支持使用富文本方式详细介绍您的商品。如果您要在详情部分引用图片,您可以直接将图片拖到富文本编辑框内即可。

e) 产品截图:可以上传您产品的截图,供客户参考。

f) 产品资质:您可以上传产品的相关证书,例如知产证书,专利证书,特殊证书等,提升客户对您产品的信任。

g) 成功案例:可以填写您的商品的成功案例,此信息将在商品详情页面进行展示,可以不填写。

h) 使用指南:上传该商品的使用帮助文档,必须上传,且运营小二会重点审查。

i) 售后支持范围:填写如果客户遇到问题,您提供何种程度的支持,另外可填写支持时间例如58,724等。

3. 商品业务信息

a) 商品所属类目:请填写您将商品放在哪个类目下,你只能在您入驻过的集市/类目范围中进行选择。对于API类商品,建议选择API集市,否则影响审核。

b) 自定义标签:标签方便客户根据标签快速查找到您的商品

c) 搜索引擎关键词及描述:有助于您的商品被搜索引擎(例如百度)收录

4. 商品销售信息

API类商品支持按次售卖和按量售卖两周模式:

  • 按次售卖: 如果您的API服务是根据API的调用次数计费的,则选择该模式。该模式也称为“套餐包”模式。

    a) 选择API售卖方式为“按次售卖”,您需要定义套餐包的价格与配额,配额即指该套餐包包括的调用次数

    b) 云市场对用户调用您的API收费,是依据用户调用您的API接口返回的HTTP状态码(HTTP Status Code)来统计调用次数。总体来说:

    • [200,300)表示用户调用成功,这种情况下云市场会计算费用;

    • [400,500)表示客户端错误,比如客户端参数输入不合法,这种情况下云市场不会计算费用;

    • [500,600)表示服务端错误,比如服务端不可用,这种情况下云市场不会计算费用;

      所以,如果您的API出现某些使用情况下不收费,需要您将对应的HTTP状态码调整到对应的区间。

  • 按量售卖(后付费):如果您的API服务不是仅仅依赖是用次数计费,而是依赖API被调用后需要消耗的后端资源来进行计费,则选择按量售卖模式。

    按量模式可配置响应的资源包,即客户如果购买资源包,则会优先消耗资源包内的配额,当超出资源包配额后,再按按量价格扣费。

    按量计费需要您将用户在API调用过程消耗资源的信息推送给云市场,云市场再对用户账号进行扣费。具体过程为:

    a) 用户购买API商品

    当用户购买API后,云市场会自动生成CaCloudMarketInstanceId,每个用户都具有且只有一个CaCloudMarketInstanceId,在用户调用API时,通过系统参数传递给服务商。

    b) 用户调用API

    ISV需要在API网关的接口中配置系统参数CaCloudMarketInstanceId,当用户产生API调用后,您可以根据这个CaCloudMarketInstanceId来区分不同用户的调用消耗的资源情况,根据Id进行一段时间内,消耗资源情况的汇总。

    ISV根据CaCloudMarketInstanceId汇总好资源消耗数据,并依据云市场统一的数据推送格式推送给云市场,云市场对用户账号进行扣费。

    计量数据推送格式及推送接口文档

    c) 用户产生欠费

    用户调用API生产欠费后,云市场会立即关闭用户调用API的权限。

    d) 用户清缴欠费

    用户缴清欠费后,云市场会立即开启用户调用API的权限。