检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 上架API至API中心门户网站 注册API到网关代理
API开放 安全性 可用性 可维护性 生命周期管理 父主题: 规范要求
工具平台 API生产阶段 API中心通过对接集成,为API开发者提供API Arts等自动化的API设计/开发/测试工具,开发者通过华为云账号登录后即可使用。 API开放阶段 API开发者(API提供方)可以在API中心申请入驻为服务商,然后自助发布上架API。上架成功后,API将
帮助。 上传文件 选择本地API文件上传。 API分组 当“导入方式”选择“API网关”时,支持选择API网关代理中的API分组。 API接口 当“导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection
获取API的调用信息 在调用API前,您需要向API提供方获取API的调用信息。 获取API的请求信息 向API提供方获取API的“域名”、“请求方法”、“API URL”、“请求参数”和“Headers”。 获取API的调用凭据 根据API使用的安全认证方式不同,还要获取相关的请求认证信息,具体参考表1。
调试API”,在线调试API。 调用API 基于已获取的API调用凭据和API接口信息,在实际的应用开发环境或工具平台调用API。 获取服务商联系方式 对于不需要付费购买的API,您可以通过以下方法获取API资产服务商的联系方式。 在API中心门户网站,单击API资产。 单击页面右上角的“订阅”。
的API分组。 API接口 当“导入方式”为下面几种之一时,支持勾选部分接口导入。如果导入全部接口,则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时,需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。
华为云 API中心 API中心(API Hub)是为API开发者和应用开发者构建的,海量API的汇聚运营平台。帮助API开发者高效便捷地分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心贯通并粘合API生产、API开放和API消费,促进API供需匹配
创建API API提供者把API接口配置在API网关代理中,开放后端能力。创建API主要分为两个步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 API网关代理是基于REST的API架构,API的开放和调用需要遵循RESTful相关规范。
产品架构 图1 API中心产品架构 API中心主要包括API工具,API门户,API网关代理,API运营四个产品模块: API工具 API中心通过对接集成API开发工具,为API开发者提供简单易用的API工具,帮助开发者高效地设计、测试API。 API门户 API中心构建面向广大
束。 必须对API进行统一注册和统一管理,API注册目标系统为API中心。在API发布过程中必须保证API注册信息的准确性,保证API符合国家法规以及安全规定的要求。 API调用成功率>=99.99% 本条规则是MUST类型的基本规则,可保障API的高可用性。 API调用成功定义
取消入驻服务商 生产API API中心为开发者引入自动化的API工具(如API Arts),帮助API开发者高效设计/开发/测试API。支持从API Arts将开发好的API文件一键式导入API中心。 支持区域: 华北-北京四 使用API Arts开发API API资产分享 API中心服务商
概述 API中心是一个汇聚了海量的API的平台。通过汇聚丰富的行业能力API,帮助API开发者高效便捷的分享和开放API,支持应用开发者快速查找所需API并进行应用开发和集成。API中心覆盖了API生产、API开放、API消费全场景,一站式体验。 本文档为您提供生产API、开放AP
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则,可提升API的安全性。 根据具体业务场景,选择API调用的认证模式,具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
注册API到网关代理 使用场景 如果您想要将已开发好的API注册到API中心网关,请参考本章指导操作。 前提条件 已完成服务商入驻,具体操作指导参考《用户指南》服务商入驻章节。 使用流程 作为API提供者开放API,您需要先后完成以下流程: 步骤1:创建API分组 进入API中心服务页面。
对于需要付费购买的API(来源于华为云市场的API),单击API资产,在API资产详情页面,单击“API接口”页签下的“调试API”,在线调试API。 (可选)获取服务商联系方式。 对于不需要付费购买的API(技术开放型API),可以通过以下步骤获取API服务商的联系方式。 单击API资产。
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则,可保障API的可维护性。 在采集API调用日志过程中,需要保证API日志的实时性和完整性,以提升API分析的精准度。 API日志在传递过程中,必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
简介 目的 主要用于指导伙伴、开发者在华为云API中心生产和开放API。通过统一的API治理框架和规范,帮助伙伴、开发者构建并提供有质量保障的API服务,为平台营造良好能力开放与交互的环境,支撑华为云和伙伴及开发者共建API生态。 API治理规范主要从安全、可用性、易用性、可维护性
谁为API使用者提供技术支持? API中心主要是作为API汇聚和运营API的平台,支撑API开发者和应用开发者更高效便捷的开放和使用API。API相关的技术支持等服务,由API提供方即API服务商负责。 父主题: API售卖与技术支持
对于需要下线的API,需要梳理订阅该API的用户,并通过公告等方式向订阅API的用户进行提醒。通知需要在服务下线前至少6个月启动,并在公告服务下线时间后1个月内对API调用进行监控,当没有API调用流量之后,才启动正式下线。待该API到了正式下线后,API中心不再展示下线的API。 父主题: API开放