API说明

基调听云Web提供直接获取报表中图表数据的HTTP接口，进而导入自己的数据库或实现自己的报表定制与集成。

参考标准

JSON（JavaScriptObjectNotation）：http://www.json.org/

HTTP协议：http://www.w3.org/Protocols/rfc2616/rfc2616.html

数据格式

API支持 JSON数据格式。

接口规范

语言（Locale）

语言缺省为简体中文（zh_CN），若需要指定其它语言，在请求头中指定：

Accept-Language: xxxx

支持的语言包括：

zh_CN
en_US
en（不区分大小写）

错误及异常处理

错误及异常通过响应状态码及响应头返回。

响应状态码（status code）：

403 – 无效的授权码或无效的API版本号。
404 – 请求的内容（账号、应用、服务器等）不存在。
400 – 无效的请求。如请求图表API的请求应为 xxxx/charts/{chart_id}.json，当用户请求xxxx/chart/{chart_id}.json（charts少了个s），或xxxx/charts/{chart_id}.csv （不支持csv格式），则返回400。
430 – 查询参数无效。
530 – 服务器端错误。

对应以上状态码，除530服务器端错误可能无法给出友好的提示外，其它错误均应在响应头中标明提示性错误描述：

Error-Message: xxxxxxx

错误描述不需要适应多语言，均为简明的英文提示（多数API客户端为程序或自动化脚本，错误描述通常用于日志输出，英文输出对于运维更友好）。标准错误提示如下：

403 – Invalid auth key “{auth_key}”

   Invalid API version “{api_version}”

404 – Account #{account_id} not found

   Application #{mobileApplicationId} not found

   Server #{server_id} not found

400 – Bad request of resource“{request_res}”

   Bad request of resource “{res_id}”

   Bad request of format “{format_ext}”

430 – Invalid parameter {param_name}: “{param_value}”, {validation_error_message}

准备工作

在获取报表中图表数据前，需要先获取悟空平台的access_token，用于身份认证。

接口调用地址：

${host}/auth-api/auth/token?api_key=xxxxx&auth=xxxxx×tamp=xxxxxx

请求参数说明：

字段名	类型	描述
api_key	String	身份校验码
auth	String	加密签名
timestamp	Long	当前请求的毫秒时间戳

返回示例：

{
	"code": 200,
	"msg": "success",
	"access_token": "hbWUiOiLkupHljZfnlLXnvZEiLCJjb"
}

返回参数说明：

参数名	描述
code	返回码
msg	返回消息
access_token	用于调用基调听云API时做身份认证

返回码说明：

code	msg	描述
200	success	成功
40001	Invalid timestamp	无效的时间戳
40002	Invalid api_key	无效的`api_key`
40003	Invalid auth	无效的签名

调用基调听云API获取数据，需要在请求的Headers里添加Authorization参数，参数值为”Bearer”+${access_token}。

Authorization示例：

Authorization= Bearer hbWUiOiLkupHljZfnlLXnvZEiLCJjb

注意：Bearer和access_token之间有一个空格。

API说明

参考标准​

数据格式​

接口规范​

语言（Locale）​

错误及异常处理​

准备工作​