API 类商品接入,即允许云市场售卖您提供的 API 类商品。本文介绍 API 类商品在云市场上架的操作步骤。

前提条件

  • 入驻 API 集市。
  • 将您的 API 服务部署在阿里云 API 网关,详情请参见发布API商品

API 类商品接入

  1. 登录云市场服务商后台
  2. 在左侧导航栏,选择商品 > 商品管理
  3. 单击发布商品
  4. 接入信息页面根据配置向导填写接入信息。
    1. 填写商品接入信息,单击下一步
      参数 描述
      选择接入类型 单击API服务
      商品名称 自定义填写商品名称。
      选择API分组 该分组即为您在 API 网关开放 API 时的分组。单击 API 分组所在地域,选择目标分组。
      API访问前缀 填写 API 地址前缀,注意该前缀全局唯一。
      是否配置API生产通知 若选择,需要填写 API 生产通知地址。用户在云市场下单后,云市场会调用您开发的 SPI 接口,通知您该用户的交易行为。

      该参数与 SaaS 类商品的 SPI 接口作用相同。详情请参见应用软件(SaaS)类商品接入SPI 接口安全方案

      阿里云2000元代金券免费领,最新优惠1折抢购,2核4G云服务器仅799元/3年,新老用户同享,立即抢购>>>

    2. 填写商品基础信息,单击下一步
      参数 描述
      商品图片 请上传商品列表页面和商品详情页面展示的商品图片。推荐图片大小为 200*150 像素。
      产品简介 请填写您的商品简介,此信息将在云市场的商品列表页面进行展示,建议字数控制在 100 字以内。
      产品亮点 请填写您商品的详细介绍信息,此信息将在商品详情页面的头部进行展示,建议尽量详情得描述您的商品。
      产品详情 支持使用富文本方式详细介绍您的商品。如果您要在详情部分引用图片,您可以直接将图片拖到富文本编辑框内即可。
      (可选)产品截图 您可以上传产品的截图,供客户参考。
      (可选)产品资质 您可以上传产品的相关证书,例如知产证书,专利证书,特殊证书等,提升客户对您产品的信任。
      (可选)客户案例 您可以填写商品的成功案例,此信息将在商品详情页面进行展示。
      使用指南 上传该商品的使用帮助文档,运营人员会重点审查。手册格式为 PDF,大小不超过10 M。
      售后支持范围 填写您可以提供何种程度的售后支持和售后支持的时间等。
    3. 填写商品业务信息,单击下一步
      参数 描述
      商品所属类目 选择您的商品所属类目。

      说明 您只能在入驻的集市中进行选择。对于API类商品,建议选择API集市,否则影响审核。

      (可选)自定义标签 设置标签方便客户根据标签快速查找到您的商品。
      商品搜索引擎优化信息 设置与商品相关的关键词和描述,有助于您的商品被搜索引擎(例如百度)收录。
    4. 填写商品销售信息,单击下一步
      API类商品支持按次售卖和按量售卖两种模式:

      • 按次售卖: 如果您的 API 服务是根据 API 的调用次数计费的,则选择该模式。该模式也称为“套餐包”模式。
        您需要定义套餐包的价格与配额,配额即该套餐包包括的调用次数。云市场对用户调用您的 API 收费,是依据用户调用您的 API 接口返回的 HTTP 状态码(HTTP Status Code)来统计调用次数。

        • [200,300) 表示用户调用成功,云市场会计算费用。
        • [400,500) 表示客户端错误,比如客户端参数输入不合法,云市场不会计算费用。
        • [500,600) 表示服务端错误,比如服务端不可用,云市场不会计算费用;

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

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

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

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

        1. 用户购买 API 商品

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

        2. 用户调用 API

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

          您需要根据 CaCloudMarketInstanceId 汇总好资源消耗数据,并依据云市场统一的数据推送格式推送给云市场,云市场对用户账号进行扣费。云市场按量数据推送接口请参见 PushMeteringData

        3. 用户产生欠费

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

        4. 用户清缴欠费

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

    5. 填写商品协议,单击下一步
      参数 描述
      最终用户协议 该协议为您和最终客户之间的协议,客户下单购买前必须勾选。您可以在云市场提供的模板基础上进行修改,也可以导入您自己的模板。
      特殊商品协议 按页面提示填写。