API商品接入

最近更新时间:2020-11-13 16:46:37

一、什么是API类产品

API类产品是指可以把后端服务、数据通过一组接口(API)提供给用户的商品形式,用户可以购买API商品用于自己开发的产品当中。

二、API类产品云市场支持的计费形式

云市场仅支持以套餐包的形式进行售卖。可以设置每一个套餐包含的调用次数、对应价格以及使用期限。 套餐包客户需要一次性预付费进行购买。 产品售卖示例如下:

API商品接入

三、接入流程简介

发布云市场API商品之前,服务商需要将API在【API网关】进行注册并调试通过。API注册成功后,可以将API发布至云市场进行售卖。接入流程如下:

API商品接入

【API网关】介绍

提供API全生命周期的托管服务,帮助开发者轻松创建、发布、管理、监控、售卖各种规模的API。可以简单快速、低成本、低风险实现内部系统集成,对外开放业务功能和数据。 详细介绍:https://docs.ksyun.com/documents/33706

在整个对接流程中,服务商只需做如下事情

1.准备好后端服务API接口

2.将API接口在金山云【API网关】进行发布(注册)

3.在云市场商家中心【商品管理】发布商品时选择关联售卖的API服务。

4.商品信息填写完成后提交审核。

由于API网关与云市场进行了打通:

1.客户购买API后,云市场会通知API网关会为客户开通对应资源,自动为客户创建对应AKSK密钥对用于API调用。

2.云市场和API网关会对API的调用次数及使用期限进行控制,如果套餐包调用次数使用完,客户将没有权限继续调用。如果套餐调用次数没有用完,但过了有效期,客户也将没有权限调用。

即服务商无需关注API的计量计费,由云市场+API网关提供对应能力,帮助服务商快速将API进行变现

四、具体对接流程

4.1在API网关发布API

如果未开通【API网关】,请按页面指引先开通服务。 1.访问【API网关】-【开发API】-【API管理】,点击【新建API】按钮

访问网址:https://uc.console.ksyun.com/pro/api/#/manage API商品接入

2.第一步【基本信息设置】中按照页面提示,设置API的信息 如果API要上架云市场售卖,注意

  • API类型请选择【公开】
  • API认证类型请选择【APP认证】

API商品接入

3.第二步【定义API请求】中按照页面提示,设置客户调用API时的前端入参信息。

注:前端入参可以与后端服务的入参不一致,客户使用前端入参调用API,API网关收到客户请求后会按映射规则转换成对应的后端请求调用后端服务

API商品接入

4.第三步【定义后端服务】中按照页面提示,填写后端服务的真实请求参数。

API商品接入

5.第四步【定义返回结果】中按照页面提示,填写API的成功/失败返回示例以及错误码定义。 API商品接入

6.完成以上步骤后,点击完成,即【API】完成了创建。

4.2调试API并发布到【线上】环境

API发布到云市场之前,请先确保注册在API网关上的API可以调试通过。调试方法如下:

A.使用在线调试工具。 目前只支持form表单参数和json格式的body参数进行调试。调试的内容为当前最新保存的API的信息。 1)入口:在API管理列表找到对应API 的调试入口。点击进入到调试页面

2)在调试界面输入请求参数,点击发送请求。查看调试结果。 API商品接入

B.使用SDK进行调试 调试前请将API发布至对应的环境(目前API网关提供了三套环境),发布后可以通过SDK调对应环境上最新版本的API。

SDK下载地址

java语言:https://ks3-cn-beijing.ksyun.com/apigeteway/Apigateway-java-sdk-1.0.0.zip

phthon语言:https://ks3-cn-beijing.ksyun.com/apigeteway/ApiGateway-python-sdk-1.0.0.zip

php语言:https://ks3-cn-beijing.ksyun.com/apigeteway/ApiGateway-php-sdk-1.0.0.zip

GO语言:https://ks3-cn-beijing.ksyun.com/apigeteway/ApiGateway-go-sdk-1.0.0.zip

调试通过后请将【API】发布至线上环境。

说明:API一旦上架到云市场。信息将不可修改。如果升级API,需要重新创建API上架到云市场。

4.2在云市场发布API产品

1.登录云市场【商家中心】-【商品管理】列表。点击发布商品。交付方式选择API。 访问地址:https://uc.console.ksyun.com/pro/market/#/serviceCompany/list

API商品接入

2.进入到【基础信息】填写页面,按页面提示填写对应信息。 API商品接入

参数 描述
商品分类 必填,根据上传商品的特性,选择对应的分类
商品标题 必填,商品品名称应描述准确,与内容相符,软件与软件著作权证书中软件名称相符
商品图片 必填,建议像素390*260
商品简介 必填,请简要介绍您的商品,该信息将会在商品列表和商品详情页面进行展示,可以让客户快速了
商品标签 解您的商品。选填,可以添加1-5个描述商品属性的标签
SEO-标题 必填,填写商品名称。类型及能解决的问题场景,利于商品被搜索引擎收录
SEO-关键词 必填,核心关键词,可增加商品被搜索的概率,利于商品被搜索引擎收录
SEO-描述 商品的具体描述/应用场景/亮点等,可吸引用户点击,,利于商品被搜索引擎收录

3.点击下一步进入到【接入信息】填写页面,按页面提示填写对应信息。 API商品接入

参数 描述
选择API分组 必填,页面会展示您在API网关发布的API分组服务,请选择您要上架云市场售卖的API分组。
分组域名 必填,此次可以定义分组域名前缀,用户云市场客户下单购买API后使用此地址进行调用

4.点击下一步进入到【商品详情】填写页面,按页面提示填写对应信息。 API商品接入

参数 描述
商品描述 必填,支持使用富文本方式详细介绍您的商品。至少包含商品详细信息,商品的核心功能和服务。
l 商品说明字体要一致,排版要规范,保持整齐美观,请勿出现大量无故换行。
l 不允许放入非金山云的外部链接等类似跳转信息。
l 不应出现通过其他方式获取商务等描述,如:商务申请或详细价格请咨询xxx。
l 避免使用广告法敏感词,如:国家级、最佳、极致、世界第一等。
产品资质 软件商品必须上传与商品名称相符的软件著作权证书,且著作权人须与发布商品公司主体一致,不可选择不涉及。
使用指南 请提供与商品相符的有效的操作手册和商品手册,而非商品介绍。
l 使用指南须说明用户从云市场购买产品后,如何登录、使用等。
l 字体要一致,排版要规范,保持整齐美观。
客户案例 您可以填写商品的成功案例,此信息将在商品详情页面进行展示。
售后支持 必填,填写您可以提供何种程度的售后支持和售后支持的时间等。至少包含服务内容、服务时间、服务电话、服务邮箱4项内容

5.点击下一步进入到【商品服务协议】填写页面

API商品接入

参数 描述
服务协议 必填,此页面是按照默认模板生成的一份协议,您可以在云市场提供的模板基础上进行修改,也可以使用您自己的模板。此协议内容是购买用户和服务商直接的法律约束协议,建议由贵司法务提供或审核后再上传。因商品产生的法律风险将由服务商提供。

6.点击下一步,进入到【售卖信息】填写页面 API商品接入 您可以维护多个规格,每个规格可定义客户购买的套餐调用次数以及价格和使用有效期。 请注意0元套餐包每个客户仅可以购买一次,非0元套餐包购买次数不受限制

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

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

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

7.内容维护完成后,可以点击预览,查看当前保存数据的前台预览效果。

8.如果所有内容都维护完成,请点击提交申请。请等待工作人员进行审核,审核通过后即可上架售卖。

9.单击【提交审核】可将商品提交审核,提交后商品为“待安全审核”状态,云市场运营人员会在7个工作日左右完成审核。

10.商品上架后,接入信息和商品服务协议不允许修改。其他信息修改后需要重新审核上架。

金山云,开启您的云计算之旅

免费注册