检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义，建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样，API名称只支持中文、字母、
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
可用性 API请求URI中如果存在特殊字符，需要进行转义编码 本条规则是MUST类型的基本规则，可保障API的高可用性。 某些字符，由于有特殊含义或者系统保留，容易被Web应用防火墙或者安全访问控制产品所阻断，导致URI调用不生效，因此不建议在URI中使用，如果必须要用需要用转义编码替换。
流量控制策略说明 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数，保护后端服务。为了提供持续稳定的服务，您可以通过创建流控策略，针对部分API进行流量控制。 使用限制 同一个环境中，一个API只能被一个流控策略绑定，但一个流控策略可以绑定多个API。 配置参数说明
可维护性 API需要保持向后兼容性 本条规则是MUST类型的基本规则，可保障API的可维护性。 现网API版本一般保留3个版本或以下，如果超过3个版本会增加API本身的维护量，建议对旧版本API进行下线处理。 服务端API改动必须保证所有的服务消费者不被破坏。API是服务端和客户
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
创建凭据并绑定API 使用APP认证的API，需要在API网关代理中创建一个凭据，以生成凭据ID和密钥对（Key、Secret）。将创建的凭据绑定API后，才可以使用APP认证调用API。 安全认证方式为“无认证”或“华为IAM认证”的API，无需创建凭据。 创建凭据 进入API中心服务页面。
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
响应消息头 调用API时，API网关代理增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关代理调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求，都会返回此参数 X-Apig-Latency 从API网关代理接收请求到后端返回消息头的用时
为简易认证绑定AppCode 简易认证指调用API时，在HTTPS请求头部消息增加一个参数“X-Apig-AppCode”（参数值填凭据详情中“AppCode”的值），而不需要对请求内容签名，API网关代理也仅校验AppCode，不校验请求签名，从而实现快速响应。 当使用APP认
生命周期管理 API接口变更在参考文档中为新版本提供迁移计划 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 在进行新版本API设计时应当考虑老版本升级迁移计划，从而实现API的迁移。新版本中继承的接口在语义上应当能兼容老版本。 对于计划不再支持的接口，需要正
为什么要申请入驻服务商？ API中心管理控制台的以下功能只允许API中心服务商使用，如果您想要使用以下功能，需要先申请入驻成为API中心服务商： API资产管理：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代
如何对API进行商业售卖？ 您可以通过华为云云商店，将API作为商品对外售卖。具体参见发布API类商品操作指南。 父主题： API售卖与技术支持
服务商入驻审核多久通过？ 提交服务商入驻申请后，运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台，查看审核进展。 父主题： 服务商入驻
谁为API使用者提供技术支持？ API中心主要是作为API汇聚和运营API的平台，支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务，由API提供方即API服务商负责。 父主题： API售卖与技术支持
服务商入驻成功后可以取消入驻吗？ 可以，API中心支持您取消入驻服务商。具体取消方法，参考取消入驻服务商章节。 父主题： 服务商入驻
服务商入驻成功后信息还可以修改吗？ 可以，API中心支持您修改服务商信息。具体修改方法，参考变更服务商信息章节。 父主题： 服务商入驻
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
