为什么要申请入驻服务商? API中心管理控制台的以下功能只允许API中心服务商使用,如果您想要使用以下功能,需要先申请入驻成为API中心服务商: API资产管理:通过创建API资产,将您开发好的API分享至API中心门户网站,供其他开发者搜索和调用。 API网关代理:API网关代
API网关代理默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。 简单请求的跨域访问 如果是创建新的API,在“安全配置”时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“请求方法
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API,用于系统集成和项目开发,请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索:输入您需要的API的一些关键信息,如API名称、描述等,系统会展示相关的搜索结果。
如果您已入驻成为华为云云商店服务商,则系统会自动填充服务商信息,您不需要再次填写服务商信息,直接执行5即可。 最多支持输入2个电话和2个邮箱。 勾选“我已阅读并同意《华为云API中心服务商合作协议》和《华为云隐私政策声明》”,单击“立即提交”。 根据您是否需要使用API网关代理功能,选择对应的操作。 是
Arts界面单击项目名称,进入目标项目详情页面。 在左侧选择“API发布”,然后单击“申请发布”,跳转至API中心“创建API资产”页面。(如果您不是API中心服务商,需要先参考服务商入驻章节,入驻成为API中心服务商,然后才能创建API资产。) 图1 申请发布 填写API资产信息。详细指导参考填写API资产信息。
API请求URI中如果存在特殊字符,需要进行转义编码 本条规则是MUST类型的基本规则,可保障API的高可用性。 某些字符,由于有特殊含义或者系统保留,容易被Web应用防火墙或者安全访问控制产品所阻断,导致URI调用不生效,因此不建议在URI中使用,如果必须要用需要用转义编码替换。 转义说明可参考:RFC
务时,保障后端服务的安全。 签名密钥由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关代理向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果和API网关代理传过来的Auth
认证描述 AppKey 在API请求Header或者Query中携带AppId和AppKey用于进行身份认证,该认证方法直接传递密钥,在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证,该认证方法对请求
仅在使用负载通道时,需要设置。选择已创建的负载通道名称。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 格式:“主机:端口”,主机为IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 端口范围:1 ~ 65535。 如果需要创建变量标识
下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API中心服务页面。
调试API API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。 后端路径中含有环境变量的API,不支持调试。 如果API已绑定流控策略,在调试API时,流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
API策略”。 在“策略管理”页面,单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型,策略内容的配置不同: 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后,您还需要为API绑定策略,才能使策略对API生效。 为API绑定策略
可用性 API需要配置并发请求及流量控制 本条规则是Should类型的扩展规则,可提升API的可用性。 在API发布之前,需要根据设计的服务等级标准进行流量控制设置。API流量控制包括三个部分:并发请求控制,吞吐量控制和传输流量控制。 并发请求控制:指API最大允许的客户端连接数量。
创建环境成功后,在“环境管理”页面的列表中显示新创建的环境。 访问环境 通过RESTful API可以访问API默认的RELEASE环境,如果访问其他环境,需要在请求头中添加X-Stage头,内容为环境名。例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 管理控制台
选择API需要发布到的环境,并填写发布说明。 如果API在选择的环境中已发布,再次发布即为覆盖该环境的API。 如果在选择环境时,没有自己需要的环境,单击“创建环境”链接,创建一个自己需要的环境。 单击“确定”,完成API发布。 已发布的API因为其他原因需要暂停对外提供服务
授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在“授权历史”弹窗中,选择需解除授权的凭据,单击“操作”列“解除授权”。 父主题: API列表
成长地图 | 华为云 API中心 API中心(API Hub)是为API开发者和应用开发者构建的,海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费,促
环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 当创建API时定义了变量标识,则需要在环境中添加变量。例如创建API时定义了变量名为“Path”,在环境1中创建了变量名“Path”,变量值“/Stage/test”,则AP
API下线前必须提前通知订阅服务的用户 本条规则是MUST类型的基本规则,可保障API租户的业务连续性。 对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API
步骤6:发布API 在左侧导航栏选择“API网关代理 > API列表”。 在需要发布的API所在行,单击“操作”列的“发布”。 选择已创建的API发布环境,并填写发布说明。 图5 发布API 单击“确定”,完成发布。 后续操作 如果您需要调用注册到API网关代理的API,请参考《用户指南》调用API章节。
您即将访问非华为云网站,请注意账号财产安全