安全性 涉及敏感信息或个人隐私数据的API,应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则,可保障API的安全合规。 API接口参数传输和存储过程中,敏感信息和个人隐私数据禁止明文传输和存储,避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括:
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
服务商入驻审核多久通过? 提交服务商入驻申请后,运营人员将在5个工作日内完成审核。您可以登录API中心管理控制台,查看审核进展。 父主题: 服务商入驻
服务商入驻 API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代理包括API的
为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代
和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API。借助API网关代理,可以简单、快速、低成本、低风险地实现内部系统集成、业务能力开放及业务能力变现。API网关代理帮
附录-API治理规范指导 概述 规范要求 工具平台
I资产名称不能重复。 公测 API资产管理 2023年2月 序号 功能名称 功能描述 阶段 相关文档 1 新增API订阅管理 支持在控制台对门户网站中已订阅的API进行管理,包括查看订阅的所有API以及取消订阅API。 公测 API订阅管理 2 优化创建API资产 创建API资产时,不需要填写API来源。
服务韧性 API中心提供了4级可靠性架构,通过全局部件跨Region容灾、Region部件跨AZ容灾、AZ内集群容灾、数据库主备容灾,保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾,当主Regio
API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 域名管理 在开放API前,您需要为API分组绑定独立域名,API调用者通过独立域名访问分组内的API。 环境 为了方便管理API的生命周期,API网关代理定义了API受限使用范围,这个受限
创建API分组 API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。您在创建API前,需要先创建API分组。 目前支持两种创建分组方式: 创建API分组 创建一个简单的分组,不包含API,用户可自行创建API。 导入Swagger文件 从本地导入已有的API文件,同步创建分组。
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
“API接口”页签下的“调试API”,在线调试API。 调用API 基于已获取的API调用凭据和API接口信息,在实际的应用开发环境或工具平台调用API。 获取服务商联系方式 对于不需要付费购买的API,您可以通过以下方法获取API资产服务商的联系方式。 在API中心门户网站,单击API资产。
APP认证(app_basic认证) 向API提供方获取该API所授权凭据的Key和Secret。 IAM认证(AK/SK认证) 获取云服务平台的用户账号的AK/SK,以及认证签名所使用的SDK。 无认证 无需认证信息。 调用API 构造API请求,示例如下: POST https://{Address}/{Path}
环境变量 API网关代理提供环境变量功能,通过创建环境变量,实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中
API中心提供服务商入驻、API工具库、API资产管理、API网关代理和API门户等能力,覆盖了API生产、API开放、API消费全场景,一站式体验。 服务商入驻 服务商入驻 API订阅管理 API订阅管理 API资产管理 创建API资产 API网关代理 创建API分组 域名管理 创建API 调试API 发布API
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。
引流;为您的API变现增加渠道。 支持区域: 华北-北京四 API订阅管理 支持您在管理控制台查看当前在API中心门户网站订阅的所有API,或者单个或批量取消订阅已订阅的API。 支持区域: 华北-北京四 管理已订阅API API数据分析 API数据分析页面通过图表的形式,直观地
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
使用限制 同一个环境中,一个API只能被一个签名密钥绑定,一个签名密钥可以绑定多个API。 使用流程 图1 签名密钥流程图 在API中心管理控制台创建签名密钥。 将新创建的签名密钥绑定API。 API网关代理将签名后的请求发送到后端服务,此时Authorization头中包含签