检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力(如实时快递查询服务)通过API接口对外开放,供外部伙伴/开发者调用集成,构建更繁荣的业务系统生态,并且触达更广泛的业务范围。 准备工作 准备好API接口文档,推荐OpenAPI 2.0/3.0格式。
开启跨域访问 什么是跨域访问 浏览器出于安全性考虑,会限制从页面脚本内发起的跨域访问(CORS)请求,此时页面只能访问同源的资源。而CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。 图1 跨域访问 浏览器将CORS请求分为两类: 简单请求 简单跨域请求的场景需要满足以下两个条件:
成长地图 | 华为云 API中心 API中心(API Hub)是为API开发者和应用开发者构建的,海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费,促
什么是API中心 API(Application Programing Interface,应用程序接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于软件或硬件得以访问一组例程的能力,而又无需访问源码或理解内部工作机制的细节。API中心是为API开发者和应用开发者构建的
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者,并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer,并将其作为API中心的API调试
可用性 API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。
负载通道 负载通道主要用于将服务通过API网关代理开放给外部访问,它的优势在于使用VPC的内部子网通信,网络时延更低,同时负载通道具有负载均衡功能,从而实现后端服务的负载均衡。 创建负载通道后,在创建API,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API,您需要先后完成以下流程: 步骤1:创建API分组 进入API中心服务页面。
身份认证与访问控制 身份认证 服务认证:API网关代理提供AK/SK、Token等多种方式进行服务认证,只允许授权的访问。 签名密钥:API网关代理提供签名密钥,用于后端服务校验API网关代理是否合法。 访问控制 流量控制:API网关代理支持从用户、IP、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。
功能总览 功能总览 全部 服务商入驻 生产API API资产分享 API网关注册 API搜索和查找 API订阅管理 API数据分析 服务商入驻 支持华为云企业用户申请入驻成为API中心服务商,然后使用API中心管理控制台的以下功能: API资产分享:通过创建API资产,将您开发好
调用API API发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 约束与限制 如果您使用系统分配的默认子域名访问API,该子域名每天最多可以访问1000次。 前提条件 在调用API前,确保您所在网络与API的访问域名或地址互通。
创建API API提供者把API接口配置在API网关代理中,开放后端能力。创建API主要分为两个步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。
错误码 用户调用API失败时,系统返回的错误码如下所示。 表1 错误码 HTTP状态码 错误码 错误描述 解决方案 404 APIC.0101 The API does not exist or has not been published in the environment.
易用性 API名称必须易于理解、见名知义 本条规则是Should类型的扩展规则,可提升API调用者的使用体验。 API名称要简洁、易于理解、见名知义,建议按照“动词+名词”格式。 在生产环境的API不能包含“test、uat、sit、beta”等字样,API名称只支持中文、字母、
上架API至API中心门户网站 使用场景 如果您想要将已开发好的API上架至API中心门户网站,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。
约束与限制 API中心的使用限制如下: 创建API资产:每个用户最多可以创建50个API资产。 API网关代理:API网关代理使用限制如表1所示。 表1 API网关代理使用限制 限制项 限制值 API分组数量 每个用户最多可以创建50个API分组。 独立域名数量 每个分组最多可以绑定5个独立域名。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
API资产管理 通过创建API资产,将您开发好的API分享至API中心门户网站,其他开发者就可以在API中心门户网站搜索到您分享的API,用于自己的项目开发。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 1个服务商最多可以创建50个API资产。 1
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关代理开放给用户调用。 API包括基本信息、前后端的请求路径、参数以及请求相关协议。 API分组
流量控制策略说明 流量控制支持从用户、凭据和时间段等不同的维度限制对API的调用次数,保护后端服务。为了提供持续稳定的服务,您可以通过创建流控策略,针对部分API进行流量控制。 使用限制 同一个环境中,一个API只能被一个流控策略绑定,但一个流控策略可以绑定多个API。 配置参数说明