检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 API中心是为API开发者和应用开发者构建的海量API的汇聚运营平台。帮助API开发者高效便捷的分享和开放API，支持应用开发者快速查找所需API并进行应用开发和集成。本文将详细介绍API中心服务的基本功能以及操作步骤。
"count":1540 } API入参/出参设计必须考虑开发者易于使用 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API设计的输入参数开发者要易于获取，输出参数要让开发者易于理解。降低开发者使用API的使用成本，提升API使用体验。避免API的输入参数要通过多次前置条件API的查询获得。
谁为API使用者提供技术支持？ API中心主要是作为API汇聚和运营API的平台，支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务，由API提供方即API服务商负责。 父主题： API售卖与技术支持
是否必须使用API中心的网关代理功能？ 不是。如果您的API已经注册在自有网关或者其他第三方网关，API中心仍然支持您创建API资产，将API展示在API中心门户网站。 父主题： API网关代理
API Arts API中心将API Arts作为API生产工具提供给API开发者，并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer，并将其作为API中心的API调试功能模块，支持开发者在API中心直接试用API。
如果请求路径中含有环境变量，则使用#变量名#的方式将环境变量定义到请求路径中，如/#path#。支持创建多个环境变量，如/#path##request#。 说明： 在URL中配置了变量标识后，在API调试页面将无法调试。 如果在URL中设置变量，那么必须在待发布环境上配置变量名和变量值，否则变量无法赋值，API将无法正常调用。
服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户端的契约，不能单方面破坏契约。通过如下的方式来保证向后的兼容性： 遵循兼容扩展标准。 忽略请求/响应中的未知字段。 只添加可选字段，不能添加必选字段。 不能更改字段的含义。 当资源URL发生变化的时候，支持重定向。 服务端提
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API，您需要先后完成以下流程： 步骤1：创建API分组 进入API中心服务页面。
允许或禁止访问的IP地址条数，分别最多可以配置100条。 账号名 输入需要允许或者禁止访问API的账号名，仅在API的安全认证方式为“华为IAM认证”时适用。 仅在“类型”为“账号名”时，需要设置。支持输入多个账号名，以英文“,”隔开，如aaa,bbb。 说明： 仅支持账号维度的访问控制，不能对单个IAM用户进行访问控制。
错误码 用户调用API失败时，系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
如何对API进行商业售卖？ 您可以通过华为云云商店，将API作为商品对外售卖。具体参见发布API类商品操作指南。 父主题： API售卖与技术支持
对于计划不再支持的接口，需要正式发布接口变更公告，应当至少提前6个月在文档标识（使用@deprecated）为不建议使用（在此期间该接口仍要能完成正常的功能），并提供替换方式的处理。 新版本API为兼容旧版本，增加的字段不建议作为强制填写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更
与“API流量限制”配合使用，表示“时长”时间内的单个API请求次数上限。 与“用户流量限制”配合使用，表示“时长”时间内的单个用户请求次数上限。 与“凭据流量限制”配合使用，表示“时长”时间内的单个凭据请求次数上限。 与“源IP流量限制”配合使用，表示“时长”时间内的单个IP地址请求次数上限。
入驻。 1个服务商最多可以创建50个API资产。 1个服务商创建的所有API资产中API接口的总数量不能超过1000个。 创建API资产 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息，配置选择导入API。
Syntax）。 API响应状态码应使用规范的HTTP状态码 本条规则是MUST类型的基本规则，可保障API的高可用性。 API响应所使用的状态码应使用规范的HTTP状态码，状态码所表达的状态与API响应状态保持一致。 具体的HTTP状态码使用可参考RFC 7231（Hypertext
如果API提供正常业务时涉及个人数据（包含收集、使用、转移、存储等），必须在API发布过程中提供产品隐私声明，描述收集的所有个人数据类型、目的、处理方式、时限等。 建议使用POST/PUT方式提交个人数据 本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。
策声明》”，单击“立即提交”。 根据您是否需要使用API网关代理功能，选择对应的操作。 是：联系API中心运营人员，并告知其您需要使用API网关代理功能。 否：直接执行7。 如果入驻服务商时没有开通API网关代理功能，后续如果想要使用API网关代理，可以变更服务商信息，然后联系API中心运营人员开通此功能。
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站，请参考本章指导操作。 前提条件 已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
Explorer，并将其作为API中心的API调试功能模块，支持开发者在API中心直接调测、试用API。 API中心聚集API开发者和应用开发者，并汇聚技术开放和商业售卖的所有API。其中，商业售卖的API，基于华为云云商店实现交易和变现。 ROMA Connect的APIC模块作为底层组件为
约束与限制 API中心的使用限制如下： 创建API资产：每个用户最多可以创建50个API资产。 API网关代理：API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
