文档首页 > > 用户指南> 服务商> 商品接入> 发布API类商品操作指导

发布API类商品操作指导

分享
更新时间:2020/10/13 GMT+08:00

前提条件

  • 发布API类商品前,您须将您的API类商品部署在华为云IAAS基础设施资源(华为云IAAS)上,华为云云市场不接受部署在非华为云IAAS上的API类商品发布申请。
  • 如果您需要发布华为云ModelArts部署在线服务生成的API类商品,具体操作请参见ModelArts 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. 根据页面提示,填写商品信息(包括“商品主图与视频”、“商品简介”、“商品说明”、“商品亮点”)和客户案例。

      • 将鼠标放置商品说明编辑框右下角可拉长编辑框,便于文字编辑。
      • 当鼠标移至已添加成功的客户案例区域,可以执行删除、编辑操作。
    7. 单击“下一步”。

      进入“资质信息”页面。

    8. 根据页面提示信息,设置“商品服务协议”、“服务与支持”,上传“使用指南”、“软件著作权证书”、“开源软件声明”。

      商品服务协议

      此协议为服务商与用户之间的双方协议,用户在下单时勾选生效,故协议内容不可为线下合同类协议,协议中不可出现留白待填写内容,协议不可盖章、签字生效。

      您也可以点击“参考样例”下载协议模板作为参考,修改模板时,商品名称、定义及各条款内容,必须与该商品一致。

      服务与支持

      内容必须包含服务时间、服务内容、热线、邮箱4项内容,并确保服务时间内各联系方式通畅,及时提供服务。

      软件著作权证书

      软件商品必须上传与商品名称相符的软件著作权证书,且著作权人须与发布商品公司主体一致,此证书将作为华为云云市场审核您发布的商品是否符合上架要求的依据,上传后的商品资质证书仅供审核使用,不会在商品详情页展示。

    9. 单击“下一步”。

      进入“业务信息”页面。

    10. 根据页面提示信息,填写商品属性、商品规格和搜索引擎优化信息。

      是否公开销售

      选择“否”,则该商品上架后在云市场前台页面与搜索结果中不会对外呈现,只能通过商品URL进行访问或购买。商品URL地址可单击“商品管理 > 我的商品”,在商品详情页面的“业务信息”模块中查看。

      商品标签

      如需添加“鲲鹏”或“混合云”标签,请将对应认证资质上传到“软件著作权证书”处。

      填写规格名称、云服务区等信息,如下图所示。

      • 在“商品规格”区域,添加规格时,若没有需要的API分组,单击“去创建API分组”,进入API网关申请界面,创建API分组。
      • API分组是同一种业务API的集合,一个API分组可视为一种服务(如征信查询服务)。API开发者以API分组为单位,管理分组内的所有API。
      • API分组对应的规格上架后,该API分组则不能再次使用,包括该规格在售及下架状态。
      • 发布API多维度商品时,计费项支持多选,上限50。
      • API类商品不支持上架后的规格新增计费方式;按次套餐包上架后,不支持修改套餐包名称及配额,仅支持修改价格,请合理设置套餐包。
      • API类商品规格无试用规格,如设置有0元套餐包,如“0元/100次”,此套餐包对同一用户,可无限次购买,请谨慎设置0元套餐包。

    11. 单击“预览”。

      系统显示该商品发布后的商品详情页面。

      “预览”功能可查看页面样式,不支持选择商品属性。

    12. 预览无误后,单击“提交”。

      系统提示“你确认要提交该商品吗?”。

    13. 单击“确认”。

      系统提示“发布商品成功!请等待审批!”。

      • 在卖家中心上传文档、软件等的单日最大上传量为10GB,每天最多上传100个文件。
      • 服务商在发布商品的过程中,单击页面右下方“存草稿”,可以将内容保存为草稿。后续可在“商品管理 > 我的申请”或“商品发布 > 草稿箱”中查看。
      • 华为云云市场会对您提供的商品信息进行审核,并在3个工作日内审核完毕,审核结果会邮件通知到贵司账号绑定的邮箱中,请注意查收;只有所有信息通过审核,您发布的商品才会正式上架。

ModelArts API商品操作步骤

发布ModelArts API类商品需要在ModelArts管理控制台部署“开启APP认证”方式的在线服务,部署方式请参见《ModelArts AI工程师用户指南》。ModelArts会为服务注册一个支持APP认证的接口并为此接口配置APP授权,您可以将生成的API关联至API网关服务发布至市场进行售卖。

本部分内容主要介绍发布ModelArts API类商品时在API网关服务的相关操作,并指导您将新建的API发布至云市场。

  1. 登录华为云首页,选择控制台 > 所有服务 > 应用服务 > API网关,进入API网关服务管理页面。
    1. 创建分组,在左侧导航选择共享版 > 开放API > API分组,单击“创建分组”
    2. 输入“分组名称”“描述”,单击“确定”,您可以在API分组列表查看创建成功的分组。
  2. 新建API,在“API管理”页面,单击“新建API”,进入API信息设置页面填写相关参数。更多关于新建API的参数描述请参见《API网关用户指南》。
    1. 填写基本信息。基本信息包含“API名称”“所属分组”“网关响应”等。其中“所属分组”请选择步骤1中创建的分组,“安全认证方式”选择“APP认证”,请打开“支持简易认证”按钮,确认信息无误后单击“下一步”
      图1 基本信息
    2. 定义API请求。填写定义API请求信息,确认信息无误后单击“下一步”
      • 为了确保安全,“请求协议”请选择“HTTPS”方式。
      • “请求Path”设置接口请求的路径。请求Path中包含请求参数时,必须设置对应的入参定义。
      • “Method”需要和在线服务API的请求方法一致。您可以登录ModelArts管理控制台,选择部署上线>在线服务,单击目标服务名称进入详情页,在“调用指南”页签查看调用方法,如图2所示。
        图2 获取Method
      • 建议开启“支持跨域CORS”
      • “入参定义”的具体参数设置您可以根据接口的具体情况或者详细咨询该模型的作者进行添加。一般情况下,目前通过ModelArts一键部署的API,不需要在此填写任何PATH、HEADER、QUERY类的参数。具体入参定义说明请参见入参定义说明
      图3 定义API请求
    3. 定义后端服务。填写相关信息,确认信息无误后单击“下一步”
      • “使用VPC通道”请务必设置为“不使用”
      • “后端服务地址”“后端请求Path”具体参数设置如图4所示,您可以登录ModelArts管理控制台,选择部署上线>在线服务,单击目标服务名称进入详情页,在“调用指南”页签获取API接口,如图5所示。
        图4 获取地址
        图5 获取API内容
    4. 定义返回结果,设置“成功响应示例”等信息后,单击“完成”
  3. 创建密钥,在“签名密钥”页面,单击“创建密钥”,填写相关参数。“密钥名称”系统自动生成,您也可以根据需求命名,其中“Key”“Secret”您可以登录ModelArts管理控制台,选择部署上线>在线服务,单击目标服务名称进入详情页,在“调用指南”页签获取,如图5所示,填写完成后单击“确定”
    图6 创建密钥
  4. 绑定签名密钥,在“API管理”页面,单击目标API名称进入详情页,在“签名密钥”页签单击“绑定签名密钥”“API运行环境”选择默认,选择步骤3创建的密钥进行绑定,单击“确定”
    图7 绑定签名密钥
  5. API绑定完成之后可以发布API并在云市场卖家中心发布API商品,具体请参见操作指导步骤5和步骤6,完成API商品发布。
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问