阿里云API网关（3）快速入门（调用 API）

网关指南： https://help.aliyun.com/document_detail/29487.html?spm=5176.doc48835.6.550.23Oqbl

网关控制台： https://apigateway.console.aliyun.com/?spm=5176.doc42740.2.2.Q4z5ws#/cn-hangzhou/apis/list

前言：调用 API 的三个前置条件：

• API：即将要调用的API，明确API参数定义。
• 应用 app：作为调用API时的身份， AppKey 和 AppSecret 用于验证身份。
• API 和 App 的权限关系：App 想调用某个 API 需要具有该 API 的权限，这个权限通过授权的功能来建立。

以下会详细说如何具备三个条件，并提供 API 调用 Demo 供参考。

一、获取 API 文档

1、从数据市场购买的 API 服务

您购买 API 服务时，如果还没有开通 API 网关服务，那么会同时帮助您开通 API 网关服务，让您使用的更流畅。

购买成功之后您进入云市场的 管理控制台，就会看见您购买的所有 API 服务。您可以在当前控制台查看 API 接口的定义。

             

您还可以跳转到 API 网关的控制台，在 已购买 API 页面，展示您购买的所有 API 服务列表，以及使用情况概况。

选择一个服务点击 查看 API ，页面会展示该服务的基本信息和 API 接口列表。注意在基本信息处关键的信息是 访问域名。

选择一个 API 接口，点击 详情，就会出现详细的接口定义了。

2、不经过购买，由提供方主动授权

提供 API 的一方需要在控制台主动操作授权，这时您需要已经创建过应用 APP，并且将 AppId告知提供方，由他们搜索您的 APP 然后操作授权。

APP 的相关内容在 创建 APP 中介绍。这里先假设您已经创建了 APP，并且提供 API 的一方已经为您的 APP 授权。

 

您进入 API 网关的控制台应用管理页面，这里是您创建的所有应用APP。

 

 

点击 APP 的名称进入 APP 详情，此处会展示 APP 的基本信息以及两个最重要的信息。AppKey 和 已授权的 API 。

 

AppKey 是您这个 APP 的 Key 和 Secret。您请求的时候需要带上这对密钥，网关会根据这对密钥对您进行身份验证。后面会详细解释。已授权的 API 是您该 APP 已经被授权的 API ，如果提供方已经操作了授权，那么您会在这里看见 API 接口。点击 详情 就可以查看详细的接口定义

以上是两种 API 渠道的获取 API 定义的方式。

二、创建应用

应用（APP）是调用 API 服务时的身份。

每个 APP 有一组 Key 和 Secret，调用 API 时这两个参数的用途如下：

• 将 AppKey 做参数传入
• AppSecret 用于签名计算，不能在请求中传递，

网关会校验这对密钥对您进行身份认证。

调用 API 需要这个 APP 具备调用该API的权限，这个授权和鉴权是面向 APP 的。您可以在 API 网关控制台 应用管理 页面创建您的 APP。

创建成功后，系统会为 APP 分配一对 AppKey 和 AppSecret。

调用服务时，客户端程序需要用 AppSecret 完成签名计算，请求时携带AppKey和签名信息1，

网关会根据AppKey找到服务器侧的AppSecret重新计算签名信息2和签名信息1比对，这就是身份验证。

在应用管理 页面，点击应用名称进入详情，就能看见 AppKey 和 AppSecret 信息了，如果密钥丢失还可以操作重置。

APP 更多说明参见 用户指南（调用API）

三、获得授权

授权，是指授予 APP 调用某个 API 的权限。您的 APP 需要获得 API 的授权才能调用该API。根据获取 API 的渠道不同，建立授权的方式也不同。

从数据市场购买的 API 服务

您购买了 API 服务就意味着您已经获得了授权。但是为了更精确的权限控制，您的账号获得了授权，不代表您的每个 APP 都获得了授权。您需要手动操作将已购买的API授权给哪些 APP，然后这些 APP 才能调用该API。

不经过购买，由提供方主动授权

您需要向 API 服务商提供您的 应用 ID (AppID) 或者阿里云邮箱账户，使 API 服务商能够搜索到您的 APP，并完成授权。完成授权后您可以在控制台看到该 APP 被授权的 API。

由提供方操作授权的 API 会出现在应用详情的 已授权 API 子页面。提供方授权时就已经将 API 授权给准确的 APP 了，所以不需要调用者来操作授权。

四、调用 API

您可以直接用 API 网关控制台为您提供的多语言调用示例来测试调用，可以自行编辑 HTTP(s) 请求来调用 API。关于签名方式，您可以参照控制台的 SDK示例下载 。

通过上述步骤，您已经获取了 API 定义文档、创建了 APP、建立了授权关系。

您可以调用 API 了。API 的请求步骤说明如下：

第一部分：请求

请求地址：http://e710888d3ccb4638a723ff8d038