调用API流程

调用API流程

API网关提供全生命周期的API管理，从设计、开发、测试、发布、运维、上架、下架等， 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。

API网关提供全生命周期的API管理，从设计、开发、测试、发布、运维、上架、下架等， 实现完整的API解决方案。帮助您轻松构建、管理和部署任意规模的API。

调用API流程

获取API

从API提供者中获取API和文档信息。

创建凭据并获取授权

使用APP认证的API，需要在API网关中创建一个凭据，并且绑定API后，才可以使用APP认证调用API。

为简易认证添加AppCode

使用简易认证，API网关也仅校验AppCode。

调用API

为简单起见，此处使用接口测试工具，通过APP认证方式中的凭证来实现对API的调用。

了解详情

创建凭据并获取授权

创建凭据

1、在左侧导航栏选择“API管理 > 凭据管理”。

2、单击“创建凭据”，填写凭据信息。

3、单击“确定”。

绑定API

1、在“关联API”区域，单击“绑定API”。

2、选择开放API中的运行环境、API分组和API，单击“确定”，完成API绑定策略。


为简易认证添加AppCode

1、在凭据列表中单击已创建凭据名称，进入凭据详情。

2、在“AppCodes”区域。

3、单击“添加AppCode”。

4、在弹窗中选择“自动生成”生成方式。

5、单击“确定”。

调用API

使用接口测试工具配置调用信息。

1、获取API请求信息。

为简单起见，此处通过线下传递方式获取API及文档。API调用者可以从中获取API认证方式，请求方法，请求路径等信息。

2、增加Header参数名称：X-Apig-AppCode，参数值填已生成的AppCode。

3、增加Header参数名称：x-stage，参数值为运行环境。若API发布到RELEASE环境不需执行此步骤。

4、单击“Send”发送请求。

调用成功后，显示“200 OK”。

API网关常见问题

API网关常见问题

  • 是否支持HTTPS的双向认证？

    专享版：支持。

    前端双向认证。在绑定独立域名时，选择带有CA证书的SSL证书，默认开启客户端认证即双向认证。

    后端双向认证。在创建API时，配置双向认证，在API网关和后端服务间启用双向认证。配置请参考创建API中的“TLS双向认证”参数说明。

    共享版：不支持，API网关仅做HTTPS的单向认证。


  • “无认证”方式的API该怎么鉴权与调用？

    “无认证”即API网关对收到的调用请求不做身份认证，您只需要按照API提供者提供的接口说明，封装规范的HTTP请求，发送给API网关即可。

    说明：无认证方式下，API网关把请求内容透传给后端服务。因此，如果您希望在API后端服务进行鉴权，可以使用“无认证”方式，API调用方传递鉴权所需字段给后端服务，由后端服务进行鉴权。


  • TLS加密协议支持什么版本？

    API网关支持TLS 1.1及TLS 1.2版本，暂不支持TLS 1.0或TLS 1.3。


  • API签名认证能否自定义鉴权方式？

    支持。请参考《用户指南》的“自定义认证”章节。


  • 安全认证签名的内容是否包括Body体

    包括。除了几个必选的请求头部参数，Body体也是签名要素之一。例如有一个使用POST方法上传文件的API，那么在签名过程中，会取这个文件的hash值，参与生成签名信息。


API网关相关视频

API网关

05:43

开放API
API网关
开放API

API网关

02:11

设置流量控制
API网关
设置流量控制

API网关

05:43

API网关
开放API

API网关

02:11

API网关
设置流量控制

API网关精选推荐

区块链服务 BCS

云日志服务 LTS

分布式缓存 DCS

漏洞扫描服务 VSS

二进制成分分析

移动应用安全
查看更多 收起

1对1咨询专属顾问

1对1免费咨询华为云专属顾问，为您量身定制产品推荐方案
立即咨询

华为云咨询电话：950808或4000-955-988 转1

华为云咨询电话：950808或4000-955-988 转1

华为云专业的服务团队，致力于为您提供专业的售前购买咨询服务，及完善的售后技术服务，助您云上无忧