SaaS 类商品发布安全规范
1.4.7 发布 API 类商品操作指导
上架流程
● 发布API类商品前,您需要先创建API分组,目前华为云云市场支持华北-北京四、
华南-广州、华东-上海一的API商品发布到云市场,请确保创建的API分组所在区 域。
● 创建API分组时,当前支持创建共享版的API分组,共享版API分组请 点击此处 进 行访问。
操作步骤
步骤1 登录华为云首页。
步骤2 选择“控制台 > 所有服务 > 应用服务 > API网关”,进入API网关服务管理页面。
步骤3 创建API分组。(若目标API分组已创建完成,此步骤可忽略。)
1. 左侧导航选择“开放API > API分组”,单击“创建分组”。
2. 输入分组名称、描述,单击确定。
说明
具体的参数说明请参考API网关用户指南。
步骤4 创建API。(若目标API已创建完成,此步骤可忽略。)
1. 单击目标API 分组所在行的“API管理”,单击“新建API”,进入API信息设置页 面。
2. 设置“API名称”、“所属分组”、“类型”、“安全认证”等信息,确认信息无 误后单击“下一步”。
3. 设置“请求协议”、“请求Path”、“匹配模式”、“Method”等信息,单击
“下一步”。
4. 设置“协议”、“请求方式”、“使用VPC通道”、“后端服务地址”等信息,
单击“下一步”。
5. 设置“成功响应示例”等信息,单击“完成”。
说明
具体的参数说明请参考API网关用户指南。
步骤5 发布API(若目标API已发布完成,此步骤可忽略。)
1. 返回API管理页面,单击目标API所在行右侧的“发布”,进入API发布页面。
2. 选择发布环境、输入发布API的说明,单击“发布”。
说明
若需要的发布环境不存在,单击“创建新环境”去创建新的发布环境。
步骤6 在卖家中心发布API商品。
1. 登录已成功入驻云市场的华为云账号,单击云市场首页页眉导航处的“卖家中 心”,进入卖家中心页面。
说明
在发布商品前,请确保华为云账号已通过企业实名认证、入驻成为云市场服务商并完成商 业信息认证,具体流程请参见入驻流程。
2. 单击左侧导航的“商品管理 > 我的商品”。
3. 单击页面右上方的“发布商品”,进入“商品发布”页面。
说明
商品信息填写必须严格按照商品发布说明中的要求,可参考API商品发布信息填写说明。
4. 在页面上方的商品接入类型中选择“API”。根据页面提示信息,填写“商品名 称”和“商品版本”,上传“商品LOGO”。
5. 单击“下一步”。
进入“基本信息”页面。
6. 根据页面提示,填写商品信息(包括“商品主图与视频”、“商品简介”、“商 品说明”、“商品亮点”)和客户案例。
说明
– 商品说明编辑框支持正文、标题和图片组合输入。为保障在详情页的展示质量,请确 保:
1、若为纯文字说明,内容不低于400字符;
2、若为图文说明,图片支持JPG/JPEG/PNG格式,图片要求宽度为900~1200px,高度 不小于800px,最多可上传5张图片;图片在详情页将按宽为1136px百分百缩放展示。
可查看参考样例。
– 将鼠标放置商品说明编辑框右下角可拉长编辑框,便于文字编辑。
– 当鼠标移至已添加成功的客户案例区域,可以执行删除、编辑操作。
7. 单击“下一步”。
进入“资质信息”页面。
8. 根据页面提示信息,设置“商品服务协议”、“服务与支持”,上传“使用指 南”、“软件著作权证书”、“开源软件声明”。
须知 商品服务协议
此协议为服务商与用户之间的双方协议,用户在下单时勾选生效,故协议内容不 可为线下合同类协议,协议中不可出现留白待填写内容,协议不可盖章、签字生 效。
您也可以在卖家中心商品服务协议编辑框下方点击“参考样例”下载协议模板作 为参考,修改模板时,商品名称、定义及各条款内容,必须与该商品一致。
服务与支持
内容必须包含服务时间、服务内容、热线、邮箱4项内容,并确保服务时间内各联 系方式通畅,及时提供服务。
软件著作权证书
软件商品必须上传与商品名称相符的软件著作权证书,且著作权人须与发布商品 公司主体一致,此证书将作为华为云云市场审核您发布的商品是否符合上架要求 的依据,上传后的商品资质证书仅供审核使用,不会在商品详情页展示。
9. 单击“下一步”。
进入“业务信息”页面。
10. 根据页面提示信息,填写商品属性、商品规格和搜索引擎优化信息。
须知 是否公开销售
选择“否”,则该商品上架后在云市场前台页面与搜索结果中不会对外呈现,只 能通过商品URL进行访问或购买。商品URL地址可单击“商品管理 > 我的商 品”,在商品详情页面的“业务信息”模块中查看。
商品标签
如需添加“鲲鹏”、“混合云”、“IoT”标签,请将对应认证资质上传到“软件 著作权证书”处。
搜索引擎优化信息
请严格按照填写指南的说明进行填写,配置适合商品的优化信息,利于百度等第 三方搜索引擎收录。
须知
– 在“商品规格”区域,添加规格时,若没有需要的API分组,单击“去创建API 分组”,进入API网关申请界面,创建API分组。
– API分组是同一种业务API的集合,一个API分组可视为一种服务(如征信查询 服务)。API开发者以API分组为单位,管理分组内的所有API。
– API分组对应的规格上架后,该API分组则不能再次使用,包括该规格在售及下 架状态。
– 发布API多维度商品时,计费项支持多选,上限50。
– API类商品不支持上架后的规格新增计费方式;按次套餐包上架后,不支持修 改套餐包名称及配额,仅支持修改价格,请合理设置套餐包。
– API类商品规格无试用规格,如设置有0元套餐包,如“0元/100次”,此套餐 包对同一用户,可无限次购买,请谨慎设置0元套餐包。
– 在卖家中心上传文档、软件等的单日最大上传量为10GB,每天最多上传100个文件。
– 服务商在发布商品的过程中,单击页面右下方“存草稿”,可以将内容保存为草稿。后
ModelArts API 商品操作步骤
发布ModelArts API类商品需要在ModelArts管理控制台部署“开启APP认证”方式的
注册一个支持APP认证的接口并为此接口配置APP授权,您可以将生成的API关联至API 网关服务发布至市场进行售卖。
本部分内容主要介绍发布ModelArts API类商品时在API网关服务的相关操作,并指导 您将新建的API发布至云市场。
1. 登录华为云首页,选择“控制台 > 所有服务 > 应用服务 > API网关”,进入API网 关服务管理页面。
a. 创建分组,在左侧导航选择“共享版 > 开放API > API分组”,单击“创建分 组”。
b. 输入“分组名称”、“描述”,单击“确定”,您可以在API分组列表查看创 建成功的分组。
2. 新建API,在“API管理”页面,单击“新建API”,进入API信息设置页面填写相 关参数。更多关于新建API的参数描述请参见《API网关用户指南》。
a. 填写基本信息。基本信息包含“API名称”、“所属分组”、“网关响应”
等。其中“所属分组”请选择步骤1中创建的分组,“安全认证方式”选择
“APP认证”,请打开“支持简易认证”按钮,确认信息无误后单击“下一 步”。
图1-9 基本信息
▪
“Method”需要和在线服务API的请求方法一致。您可以登录ModelArts管理控制台,选择“部署上线>在线服务”,单击目标服务名 称进入详情页,在“调用指南”页签查看调用方法,如图1-10所示。
图1-10 获取 Method
▪
建议开启“支持跨域CORS”。▪
“入参定义”的具体参数设置您可以根据接口的具体情况或者详细咨询 该模型的作者进行添加。一般情况下,目前通过ModelArts一键部署的 API,不需要在此填写任何PATH、HEADER、QUERY类的参数。具体入 参定义说明请参见入参定义说明。图1-11 定义 API 请求
▪
“使用VPC通道”请务必设置为“不使用”。▪
“后端服务地址”和“后端请求Path”具体参数设置如图1-12所示,您 可以登录ModelArts管理控制台,选择“部署上线>在线服务”,单击目 标服务名称进入详情页,在“调用指南”页签获取API接口,如图1-13所 示。图1-12 获取地址
图1-13 获取 API 内容
d. 定义返回结果,设置“成功响应示例”等信息后,单击“完成”。
3. 创建密钥,在“签名密钥”页面,单击“创建密钥”,填写相关参数。“密钥名 称”系统自动生成,您也可以根据需求命名,其中“Key”和“Secret”您可以登 录ModelArts管理控制台,选择“部署上线>在线服务”,单击目标服务名称进入 详情页,在“调用指南”页签获取,如图1-13所示,填写完成后单击“确定”。
图1-14 创建密钥
图1-15 绑定签名密钥
5. API绑定完成之后可以发布API并在云市场卖家中心发布API商品,具体请参见操作 指导步骤5和步骤6,完成API商品发布。