聚合API文档阅读帮助

该文基于聚合云数据开放平台的API文档,目的使得开发者能够方便的快速了解我们这个API文档的结构,从而能够经行高效的开发。

该API文档总共有6个大类:国外API、国内API、聚合数据API、聚合云数据平台使用教程、android系统教程、android开发教程。看名字基本也知道个大概了,这里我们着重介绍下几个API文档的阅读。关于教程,里面介绍了一些基本的android开发文档、加密解密技术,聚合数据平台的调用等等。有兴趣的读者请参考里面详细的内容。

国外API、国内API里面都是些国内外开放的API,我们在这里做了个收集和整理的工作,便于开发者找到他理想中的数据,从而经行他的开发工作。聚合数据API,我们提供了

包括LBS、资讯、交通、金融、日常生活等等的千万量级数据,供开发者选择。后续我们将会同数据商合作,持续不断地壮大我们的数据服务,供开发者使用。下面我们来介绍下,如何阅读这个API文档。

       第一步:选择一个具体的API。下图我们选择了国外——旅游——CleartripAPI

聚合数据java如何使用_json

       第二步:当我们选定一个具体的API的时候,在下方会出现如下图的包括数据结构列表和API列表的一个展示区。有两个数据结构代表该分类下有两个API。

聚合数据java如何使用_移动开发_02

第三步:点击进入一个数据结构,这里我们点击ClearTrip Flights API。右方出现一个如下图的展示。这里包括所属类目、简要描述、属性三个大类。见名知意,属性里面包括类别(该API所属的类别,譬如旅游)、格式(指该API支持的数据返回格式,有XML、JSON等)、API主页(指这个API的来源,因为像国内外的API都是经过我们整理的第三方API,在这里我们提供了这个API的来源,供开发者查看,方便开发者透彻的理解该API)

聚合数据java如何使用_json_03

第四步:点击进入一个API列表(这列表下的API都是按照功能划分的,目的使得开发者清晰地了解该API所具有的功能),这里我们点击ClearTrip Flights API_1(航班搜索)。右侧出现具体的API说明,结构包括:如遇N/A,则代表该项为空

1、  API用户授权类型(聚合云数据平台下的数据需要聚合授权请参考聚合云数据平台使用教程,国内外的API根据各个API的要求不同确定是否需要授权)。

聚合数据java如何使用_聚合数据java如何使用_04

2、  简要描述。该功能的简要描述。

聚合数据java如何使用_API_05

3、  系统级参数(包括基本URL和请求方法)。

聚合数据java如何使用_API_06

4、  应用级输入参数(一些所需参数的展示及说明介绍)。

聚合数据java如何使用_json_07

5、  请求及请求示例。这两个的区别在于一个是链接式的请求,一个是代码块式的请求。两个只能有一个存在。

示例一:

聚合数据java如何使用_移动开发_08

示例二:国外——实用工具——USA Weather Forecast_GetWeatherByPlaceName

聚合数据java如何使用_移动开发_09

6、  返回结果及返回示例。这两者的区别在于一个是链接式的、一个是代码块式的。两个只能有一个存在。

示例一:

聚合数据java如何使用_API_10

示例二:国外——实用工具——USA Weather Forecast_GetWeatherByPlaceName

聚合数据java如何使用_移动开发_11

7、  错误码。一些错误信息代码的展示。

聚合数据java如何使用_移动开发_12

8、  FAQ(常见问题)。

国外——房地产——Zillow API

聚合数据java如何使用_json_13