企业对外开放API供外部伙伴/开发者调用集成

操作场景

企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。

准备工作

• 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
• 准备好API使用指南，说明API凭据获取方式、以及提供API使用时的补充说明信息。
• API对应的后端服务已部署上线，并且推荐提供服务域名或IP地址，有助于伙伴/开发者便捷地在线调试API。
• 已注册华为账号并开通华为云，并已完成企业实名认证。

操作流程

对外开放API的操作流程如图1所示。

图1 对外开放API流程

入驻API中心服务商

1. 进入API中心服务页面。
2. 在左侧导航栏选择“服务商入驻”。
3. 单击页面中间的“立即入驻”。
   图2 入驻API中心服务商
   
   

   也可以在API中心门户网站，单击页面右上角的“服务商入驻”，进入服务商入驻页面。

4. 填写服务商信息。
   图3 申请入驻API中心
   
   

   • 如果您已入驻成为华为云云商店服务商，则系统会自动填充服务商信息，您不需要再次填写服务商信息，直接执行5即可。
   • 最多支持输入2个电话和2个邮箱。

5. 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”，单击“立即提交”。
6. 根据您是否需要使用API网关代理功能，选择对应的操作。
   • 是：联系API中心运营人员，并告知其您需要使用API网关代理功能。
   • 否：直接执行7。
   

   如果入驻服务商时没有开通API网关代理功能，后续如果想要使用API网关代理，可以变更服务商信息，然后联系API中心运营人员开通此功能。

7. 等待审核。5个工作日内完成审核。您可以登录API中心管理控制台，查看审核进展。

   审核通过后，您登录API中心管理控制台，就可以看到API资产管理等菜单了。

创建API资产

1. 选择左侧导航栏中的“API资产管理 > API资产”。
2. 单击页面右上角的“创建API资产”。
3. 填写API资产信息。
   1. 根据表1参数信息，配置选择导入API。

      表1 选择导入API

      参数名称	说明
      导入方式	支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI 2.0/3.0标准的txt、yml、yaml、json格式的API文件。 API网关：支持将API网关代理中已发布的API，上架至API中心门户网站。 Postman Collection：支持将Postman Collection开发的API，上架至API中心门户网站。 Markdown压缩包：支持导入Markdown编辑的API文件，且该文件需要压缩为zip包导入。 URL：填写您API资产的URL地址，系统会将URL地址内的API资产展示在API中心。 API Arts：支持从API Arts工具直接把开发好的API文件一键式导入API中心。 说明： 仅从API Arts工具导入API资产时，导入方式这里会显示“API Arts”页签。 如果您的Markdown压缩包中文件的数量超过100个，导致文件无法导入，您可以通过向系统提交工单来寻求帮助。
      上传文件	选择本地API文件上传。
      API分组	当“导入方式”选择“API网关”时，支持选择API网关代理中的API分组。
      API接口	当“导入方式”为下面几种之一时，支持勾选部分接口导入。如果导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection API Arts
      API URL	当“导入方式”为“URL”时，需要填写API资产的URL地址。

   2. 根据表2参数信息，配置资产基本信息。

      表2 资产基本信息

      参数名称	说明
      资产名称	自定义API资产的名称。 说明： 同一个华为云账号下的API资产名称不能重复。
      图标	为API资产设置一个图标。如果不设置，则显示默认图标。
      资产简介	简单介绍下API资产的行业，用途等。
      使用指南	描述API的调用方法。
      资产域名	API服务的主机域名或IP，用于API在线调试。
      分类	选择API资产所属行业，方便API资产在API中心门户网站按行业类别被搜索。
      可见范围	公开：创建API资产成功后，所有用户都能在API中心门户网站中看到该API资产。 私有：创建API资产成功后，仅创建该API资产的用户能在API中心门户网站中看到该API资产。
      标签	为该API资产添加个性标签，方便用户通过标签了解API资产的特点。

4. 填写完API资产信息后，单击“立即创建”。

   等待系统解析API文件。API资产所在行“状态”列如果显示“已上架”，说明解析完成。此时，API资产已成功分享至API中心门户网站。