API交付类商品制作说明
所有文档

          云市场 Market

          API交付类商品制作说明

          API交付类商品概述

          服务商将一个或多个API作为商品,供用户调用,即为API交付。服务商需要将待发布的商品在API网关中配置后,在云市场选择相应的API发布为商品。

          API交付类商品接入

          1. 在API网关创建分组,编辑并发布API;
          2. 根据API网关的调用指南说明,自测API是否可成功调用;

             以上步骤可参考API网关-开放指南

          1. 根据API中心的使用指南说明,补充API相关描述信息

            以上步骤可参考API中心-使用指南

          2. 在商品编辑页面选择要使用的API域名,并选择要发布的API;

          注意:API网关分组和此处填写的域名为一一对应关系,变更分组会影响已购用户的服务调用。所以API交付类商品在商品发布环节选择分组后不可更改,并且请勿在API网关下线对应API或删除对应分组。

          image.png

          1. 选择API所对应在API中心的描述信息

          image.png

          注:商品详情页的API信息将完全使用API中心的配置进行展示

          1. 确认API的定价,API商品按次收费,用户购买后有效期为1年;

          image.png

          image.png

          1. 确认信息无误后提交审核;

          image.png

          1. 请您耐心等待,审核通过后商品自动上线,此期间您可以在商品列表中查看审核状态

          image.png

          注意:

          1. 在API网关编辑API时,请根据相关提示填写详细的API信息,API信息将作为API商品说明的重要部分供用户参考,详细的API信息有助于用户快速了解API的用途及调用方式。
          2. 在API网关编辑API时,请勾选“允许上架至云市场”选项,安全认证方式请选择“APP AK/SK”。
          3. API编辑结束后,请发布至线上环境。只有发布至线上环境的API才能在商品编辑页面选择。
          4. API中心编辑完毕后请发布服务。只有发布后的API才能在商品编辑页面选择
          5. 商品上线后,请勿修改API网关和API中心相应API的定义。
          6. API商城详情页的API展示信息将完全使用API中心的定义信息。
          7. 请根据实际情况合理设置API商品的价格。由于API网关将对用户的调用向服务商收取相应的费用(收费标准见:API网关 - 产品定价),请谨慎发布价格为0元的商品。
          8. 云市场API交付类型商品会根据 API 的调用次数计费,用户通过购买配额包(配额包即包含XX次调用次数)来实现API的调用。云市场对用户的 API 计费(消耗配额),是依据用户调用API 接口返回的 HTTP 状态码来统计的:

            • 当状态码为 [200,300) 区间时,表示用户调用成功,云市场会计算费用。
            • 当状态码为 [500,600) 区间时,云市场不会计算费用;
          上一篇
          BCH模板交付类商品制作说明
          下一篇
          硬件类商品接入说明