全部产品
云市场

步骤1:获取 API 文档

更新时间:2017-07-05 14:39:01

根据您获取API的渠道不同,获取方式略有差异。

从数据市场购买的 API 服务

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

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

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

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

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

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

提供 API 的一方需要在控制台主动操作授权,这时您需要已经创建过应用 APP,并且将 AppId告知提供方,由他们搜索您的 APP 然后操作授权。APP 的相关内容在 创建 APP 中介绍。这里先假设您已经创建了 APP,并且提供 API 的一方已经为您的 APP 授权。

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

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

  3. AppKey 是您这个 APP 的 KeySecret。您请求的时候需要带上这对密钥,网关会根据这对密钥对您进行身份验证。后面会详细解释。

  4. 已授权的 API 是您该 APP 已经被授权的 API ,如果提供方已经操作了授权,那么您会在这里看见 API 接口。点击 详情 就可以查看详细的接口定义了。

以上是两种 API 渠道的获取 API 定义的方式。后一种其实就涵盖了提供方自测的情形。