跳到主要内容

API接口说明文档

Terraqt Restful API

版本信息

  • 版本 : 1.0
  • 上线时间:2022-01-25
  • 最后更新时间:2022-02-25

接口介绍

简介

  • 大地量子对外开放接口提供了完善便捷的接口调用服务,帮助用户将大地量子的数据产品快速接入到已有地图应用中,实现时空数据产品与用户应用的深度融合。
  • 可满足用户灵活的前端组件开发需求,便于用户进行二次开发。

为什么使用API

  • 大地量子提供SaaS、SDK、API 三种接入方式,用户可根据需求选择最适合的方式,具体区别如下方表格所示。如用户希望更灵活的开发前端组件,大地量子推荐使用API接入!
    说明特点开发难度地图展示灵活程度
    SaaS平台无需安装,无需调试,无需培训,大地量子的标准化时空数据SaaS服务,帮助时空数据使用者通过简单的登录即可查看各类数据产品,并使用我们设计的各种功能。大地量子SaaS使用手册无需开发,通过网页登录即可使用。
    SDK大地量子为地图应用开发经验有限的用户和开发者提供了完善的前端时空数据产品SDK组件。本组件基于低代码理念设计,可将大地量子精心设计的时空数据前端显示模块无痕嵌入其他应用界面,并可以自由开放或隐藏各种功能。JS-SDK接入实现指南复制七行代码即可完成接入;有经验的前端工程师可在10分钟内完成接入工作
    API对于有地图应用开发经验的用户和开发者,大地量子提供标准化的图层瓦片服务,帮助用户快速接入大地量子的图层数据,快速实现时空数据产品与用户应用的深度融合。灵活开发前端地图组件,WMTS图层接入简便且渲染效果强大

基本规范

  • 传输方式:采用 HTTP 传输
  • 提交方式:采用 POSTGET 方法提交
  • 数据格式:提交数据及返回数据都采用 json 格式
  • 返回数据基本结构:
    • 接口返回数据的基本结构包含下列五个参数:
      参数名数据类型说明
      codeint 返回状态码
      successboolean 返回结果:true=成功;false=失败
      msgstring 错误消息
      retryboolean 是否重试:true/false
      dataobject 业务数据,参考各个接口返回字段的说明

重点概念说明

Untitled

  • 服务 (serviceId):
    • 大地量子将用户需要的多种时空数据产品打包成为一个服务提供给用户使用;
    • 每个服务会定义不同的多种数据产品、数据时间、数据空间范围等关键信息。
    • *用户可调用的数据就是大地量子SaaS平台中账号下绑定的全部服务, 登录查看服务列表
    • 如上图所示,图中是“地表覆盖监测-内蒙案例“服务,重点展示地表覆盖的数据产品
  • 数据产品 (tqDsCode):数据产品选择器组件
    • 大地量子提供丰富的时空数据产品,例如农作物识别、森林识别、农作物长势监测、水质参数、沉降监测、洪水监测等等;
    • 数据产品分为三种类型:地物 (cor)、地物属性 (der)、事件 (eve)
    • 每个数据产品都会有一个唯一编号 (tqDsCode),根据编号即可查询数据产品的数据。
  • 空间范围 (spaceKey):空间选择组件
    • 不同的数据产品可能会对应不一样的空间范围
    • 用户可以通过 spaceKey 来查询对应空间范围里的数据产品。
    • 大地量子提供两种空间范围边界,分别是行政区划自定义空间
    • 行政区划 (adminSpace):
      • 按照国家标准的省级、地级、县级、乡级行政区划进行空间范围的区分。
    • 自定义空间 (customSpace):
      • 人为圈定的空间范围,例如一个农场的边界范围或是一个水库管理区的边界范围。
  • 数据时间 (timeLine):时间轴组件
    • 时空数据的时间属性,例如每月1号更新一次森林识别,一年就会有12期森林识别的数据。
    • 数据更新频率:
      • 不同类型的数据产品将会存在不同的更新频率,例如每月更新一次或数次
      • 请在开发前确认所需数据产品的更新频率,从而实现定期获取最新数据
  • WMTS图层 (dataFile):WMTS图层渲染
    • WMTS图层是大地量子提供的时空数据成果,以图层URL的形式存在,通过调用WMTS图层链接即可将图层加载到地图应用中显示。
    • WMTS图层需要根据需求叠加在卫星影像地图或矢量地图上,如上图所示,大地量子接入的地图底图为 天地图
    • 关于WMTS图层服务的具体介绍,请阅读 WMTS图层服务
    • 图层分为栅格和矢量两种数据类型,具体区别可参考什么是栅格与矢量数据
  • 统计数据 (databox):统计数据展示组件
    • 数据产品的相关统计数据会在获取图层的接口中一并返回,开发者可根据返回的数据自行开发数据可视化的样式。

接口使用说明

按下列顺序操作,即可完成整个接入调用流程!

准备工作

获取账号标识及服务标识

操作流程:

  • 注册登录大地量子时空SaaS平台
  • 点击左上角按钮,切换到接入指南,即可查看并获取账号标识 ( token ) 及当前所选服务的服务标识 ( serviceId )。账号标识及服务标识会用于后续获取服务中的相关数据。

/img/api1.png

/img/api2.png

获取身份认证信息

接口描述:

  • 通过账号标识 ( token ) 获取用户身份验证码 ( secret)
  • secret会用于调用下列其他接口时的身份校验

请求URL:

请求方式:

  • POST

表头:

  • Host:<calculated when request is sent>

参数:

参数名是否必填类型说明
tokenstring账号标识

输入示例

{
"token": "XXXXXXXXXXXXXXXXXXXXXXX"
}

返回数据体

参数名说明
userGuid用户ID,与token相同
secret身份认证码,用于调用业务接口时校验身份
description描述

返回示例

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"userGuid": "XXXXXXXXXXXXXXXXXXXXXXX",
"secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"description": null
}
}

基础接口

获取服务包含的数据产品及空间范围

接口描述:

  • 根据 serviceId,获取服务下包含的数据产品的类型及图例配置,以及空间范围信息
  • 通过该接口,可以获取到数据产品的编号、空间范围信息,为后续获取对应的数据图层做准备

请求URL:

请求方式:

  • GET

表头:

  • Host:<calculated when request is sent>
  • user-id:用户ID,与token相同
  • secret:身份认证码

参数:

参数名是否必填类型说明
serviceIdstring服务ID

输入示例

{
"serviceId": "fe1c2b38-f447-4290-a6d7-8f9ea677e8d3"
}

返回数据体

参数名嵌套参数说明
serviceId服务ID
customSpace自定义空间的信息
cspace_key自定义空间的唯一标识
parent_cspace_key自定义空间的父级空间标识
name自定义空间的名称
adminSpace行政区划的信息
aspace_key行政区划的唯一标识
parent_aspace_key行政区划的父级行政区划标识
name行政区划的名称
serviceName服务名称
prodList数据产品清单
corList地物数据产品列表
derList地物属性数据产品列表
eveList事件数据产品列表
code数据产品编号
name数据产品名称
parentCode关联的数据产品编号 (例如长势监测关联的数据产品可能是小麦或水稻,不同的关联TQDS对应的是不同的数据图层)
type数据产品图层类型 (tms=栅格图层,obj=矢量图层)
tqDsConfigs数据产品配置信息 (数据产品图层的图例信息)
tqdsCode数据产品编号
tqdsType数据产品的类型 (cor=地物,der=地物属性,eve=事件)
tqdsCustomColor数据产品图例颜色
type图例类型 (palette=单值染色,interp=插值染色,discrete=区间染色),具体说明请参考下方的“WMTS图层前端渲染示例
value图例颜色列表
color图例颜色
label图例名称
dn_value图层数值。当图例类型为插值时,返回中会显示dn_value_anchor,和dn_value的意义相同;当图例类型为区间时,返回中会显示dn_value_start和dn_value_end,代表对应图例的开始和结束数值。当图例类型为插值和区间时,图层中不同的数值会染色为不同的颜色。
unit图例的单位,例如毫米、米等;空值表示无单位

返回示例:

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": [
{
"serviceId": "fe1c2b38-f447-4290-a6d7-8f9ea677e8d3",
"customSpace": [
{
"cspace_key": "227b3482-ea64-49b2-9d69-e343a51f43e7",
"parent_cspace_key": null,
"name": "雹灾区域"
}
],
"adminSpace": [],
"serviceName": "雹灾损失评估-兵团案例",
"prodList": {
"cor_list": [
{
"code": "cor101",
"name": "耕地",
"type": "obj"
}
],
"der_list": [],
"eve_list": [
{
"code": "eve1.d",
"name": "雹灾事件",
"parent_code": [
"cor101"
],
"type": "obj"
}
]
},
"tqDsConfigs": [
{
"tqdsCode": "cor101",
"tqdsType": "cor",
"tqdsCustomColor": {
"type": "palette",
"value": [
{
"color": "#f8d072",
"label": "耕地",
"dn_value": "1",
"dn_value_anchor": null,
"dn_value_start": null,
"dn_value_end": null
}
],
"meta": null
}
},
{
"tqdsCode": "eve1.d",
"tqdsType": "eve",
"tqdsCustomColor": {
"type": "interp",
"value": [
{
"color": "#f0f5ff",
"label": null,
"dn_value": null,
"dn_value_anchor": "0",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#fff59d",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.1",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#e8f30e",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.2",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#ebe210",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.3",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#e8a813",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.4",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#e97711",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.5",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#eb2710",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.6",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#c00413",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.7",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#880517",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.8",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#7f0855",
"label": null,
"dn_value": null,
"dn_value_anchor": "0.9",
"dn_value_start": null,
"dn_value_end": null
},
{
"color": "#200258",
"label": null,
"dn_value": null,
"dn_value_anchor": "1",
"dn_value_start": null,
"dn_value_end": null
}
],
"meta": {
"unit": ""
}
}
}
]
}
]
}
获取服务包含的数据产品的全部图层数据

接口描述:

  • 根据 serviceId,获取服务下包含的数据产品的全部WMTS图层及统计数据
  • 通过该接口,可将获取到的WMTS图层和统计数据接入到用户自己的地图应用中

请求URL:

请求方式:

  • GET

表头:

  • Host:<calculated when request is sent>
  • user-id:用户ID,与token相同
  • secret:身份认证码

参数:

参数名是否必填类型说明
serviceIdstring服务ID

输入示例

{
"serviceId": "fe1c2b38-f447-4290-a6d7-8f9ea677e8d3"
}

返回数据体

参数名说明
tqDsCode数据产品编号
tqDsName数据产品的名称
databox数据产品的统计数据
area数据产品的面积 (单位:平方米)
cor_area数据产品的面积 (单位:平方米,目前和area无区别)
der_max数据产品属性的最大值
der_meanv数据产品属性的平均值
der_min数据产品属性的最小值
feature_count数据产品包含矢量的数量
percent数据产品占当前空间范围的面积占比
percentage数据产品占当前空间范围的面积占比 (目前与percent无区别)
tileData图层的相关数据
originalFile该数据产品的矢量图层原始连接,只针对矢量数据类型有效
batchType批次类型 (vector=矢量图层,raster=栅格图层)
serviceId服务ID
spaceKey空间范围的标识
parentTqDsCode关联的数据产品编号 (例如长势监测关联的数据产品可能是小麦或水稻,不同的关联TQDS对应的是不同的数据图层)
dataFile该数据产品的图层链接 (图层渲染示例请参考下方的“WMTS图层前端渲染示例”)
timestamp图层的数据时间
maxZoom图层最大缩放层级 (超过最大层级的图层未切分瓦片,无瓦片数据)

返回示例:

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": [
{
"success": true,
"processMsg": "finished",
"tqDsCode": "eve1.d",
"tqDsName": "雹灾事件",
"databox": {
"area": "31714245.308",
"percentage": "0.737",
"feature_count": 418,
"der_min": null,
"der_max": null,
"der_meanv": null,
"cor_area": null,
"percent": null
},
"tileData": {
"batchType": "vector",
"serviceId": "fe1c2b38-f447-4290-a6d7-8f9ea677e8d3",
"spaceKey": "227b3482-ea64-49b2-9d69-e343a51f43e7",
"parentTqDsCode": null,
"dataFile": "https://dev-tile.terraqt.com/tile/xyz/{z}/{x}/{y}.pbf?path=fe1c2b38-f447-4290-a6d7-8f9ea677e8d3/cor101/eve1.d/20210817/227b3482-ea64-49b2-9d69-e343a51f43e7/vectortiles",
"originalFile": "https://dev-tile.terraqt.com/tile/geojson?path=fe1c2b38-f447-4290-a6d7-8f9ea677e8d3/cor101/eve1.d/20210817/227b3482-ea64-49b2-9d69-e343a51f43e7/vectortiles",
"timestamp": "20210817",
"maxZoom": 14
}
},
{
"success": true,
"processMsg": "finished",
"tqDsCode": "cor101",
"tqDsName": "耕地",
"databox": {
"area": "31838411.418",
"percentage": "0.7399",
"feature_count": 449,
"der_min": null,
"der_max": null,
"der_meanv": null,
"cor_area": null,
"percent": null
},
"tileData": {
"batchType": "vector",
"serviceId": "fe1c2b38-f447-4290-a6d7-8f9ea677e8d3",
"spaceKey": "227b3482-ea64-49b2-9d69-e343a51f43e7",
"parentTqDsCode": null,
"dataFile": "https://dev-tile.terraqt.com/tile/xyz/{z}/{x}/{y}.pbf?path=fe1c2b38-f447-4290-a6d7-8f9ea677e8d3/cor101/202108/227b3482-ea64-49b2-9d69-e343a51f43e7/vectortiles",
"originalFile": "https://dev-tile.terraqt.com/tile/geojson?path=fe1c2b38-f447-4290-a6d7-8f9ea677e8d3/cor101/202108/227b3482-ea64-49b2-9d69-e343a51f43e7/geojsontiles",
"timestamp": "202108",
"maxZoom": 14
}
}
]
}
WMTS图层前端渲染示例
  • 进行WMTS图层前端渲染之前,用户需选择一款合适的地图应用框架,推荐的主流地图应用框架有openlayersmapboxGLLeaflet高德API等。
  • 数据图层 (dataFile)分为栅格图层矢量图层两种
  • 如有疑问,请参考大地量子在github上的图层渲染接入示例 — Github页面
    • 目前暂时提供了openlayer地图框架下图层渲染的示例,如开发者使用的是其他地图框架,请联系大地量子业务人员获取对应地图框架的接入示例。
    • 如果用户使用的地图框架无法支持WMTS图层接入,请联系大地量子业务人员获取其他类型的图层数据。
  • 数据图层的染色方式分为单值染色、插值染色和区间染色,示例中提供了染色的示例代码
    • 单值染色 (palette):在数据图层中,每个值对应某种颜色。
      • 例如: Untitled
    • 插值染色 (interp):在数据图层中,某个数值对应某种颜色,而两个数值之间的数值,会自动取值为中间融合颜色;例如,数值为0时颜色是黄色,数值为1时颜色为红色,当数值为0.5时,会自动将黄色和红色差值生成橙色来展示0.5这个数值。
      • 例如 Untitled
    • 区间染色 (discrete):在数据图层中,用一种颜色表示一个数值区间的数据。例如用绿色表示农作物长势数值从0.800到1.000范围的数据,用红色表示长势数值从0.000到0.300范围的数据。
      • 例如 Untitled
获取某个空间范围的地理信息数据

接口描述:

  • 使用spaceKey来获取空间范围的地理信息,包含空间的名称、面积及边界范围等数据
  • 可将获取到的空间范围的矢量边界叠加到地图上作为数据图层的范围标识

请求URL:

请求方式:

  • GET

表头:

  • Host:<calculated when request is sent>
  • user-id:用户ID,与token相同
  • secret:身份认证码

参数:

参数名是否必填类型说明
spaceKeystring空间范围的标识

输入示例

{
"spaceKey": "227b3482-ea64-49b2-9d69-e343a51f43e7"
}

返回数据体

参数名说明
spaceKey空间范围的标识
parentSpaceKey父级空间范围的标识
objPolygon边界范围(矢量多边形)
spaceName空间范围的名称
area空间范围的面积 (单位:平方米)
level行政区划的层级 (10=国家级,20=省级,30=市级,40=县级,50=乡镇级)
spaceType空间类型 (ADMIN=行政区划,CUSTOM=自定义空间)

返回示例

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"spaceKey": "227b3482-ea64-49b2-9d69-e343a51f43e7",
"parentSpaceKey": null,
"objPolygon": "{ \"type\": \"Polygon\", \"coordinates\": [ [ [ 80.822656875331049, 40.54439307524207 ], [ 80.954700446963017, 40.53942450299138 ], [ 80.954248758576583, 40.504343371645604 ], [ 80.822054624149146, 40.510365883464623 ], [ 80.822656875331049, 40.54439307524207 ] ] ] }",
"spaceName": "雹灾区域",
"area": "43029791",
"level": null,
"spaceType": "CUSTOM"
}
}

高级接口

获取数据产品的空间范围数据

接口描述:

  • 使用 serviceIdtqDsCode 来获取数据产品的空间范围
  • 可将获取的空间范围做成空间范围选择器组件,让用户在前端可自由切换空间范围

请求URL:

请求方式:

  • POST

表头:

  • Host:<calculated when request is sent>
  • user-id:用户ID,与token相同
  • secret:身份认证码

参数:

参数名是否必填类型说明
serviceIdstring服务ID
tqDsVOSarray大地数据标准对象编码VO列表 (View Object视图层对象,前端使用对象)包含:数据产品编号列表 (tqDsCodes)
tqDsCodesstring数据产品编号 (如果输入多个编号,则会返回对应空间范围的并集)
tqDsParentCodesstring关联的数据产品编号 (当一个数据产品包含关联的数据产品编号,请求时需要填写关联的数据产品编号才能获取到对应的数据)

输入示例1 (示例中获取的是自定义空间信息)

{
"serviceId": "b3affb00-0289-4960-8aa3-e2323e93dccb",
"tqDsVOS": [
{
"tqDsCodes": [
"cor999"
]
}
]
}

返回数据体1

参数名说明
adminSpaces行政区划空间数据列表
customSpaces自定义空间数据列表
spaceKey空间范围的标识
spaceName空间范围的名称
parentSpaceKey父级空间的标识

返回示例1

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"adminSpaces": null,
"customSpaces": [
{
"spaceKey": "58c4b935-b8e0-474c-aa50-ceaafbf4d007",
"spaceName": "黑水县西尔滑坡监测区",
"parentSpaceKey": null
}
]
}
}

输入示例2 (示例中获取的是行政区划信息)

{
"serviceId": "7ffcdbe9-5042-40b4-bcbb-8c5905431b29",
"tqDsVOS": [
{
"tqDsCodes": [
"cor101",
"cor102",
"cor103"
]
}
]
}

返回数据体2

参数名说明
adminSpaces行政区划空间数据列表
customSpaces自定义空间数据列表
spaceKey空间范围的标识
spaceName空间范围的名称
parentSpaceKey父级空间的标识

返回示例2

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"success": true,
"processMsg": "finished",
"adminSpaces": [
{
"spaceKey": "CN-152221",
"spaceName": "科尔沁右翼前旗",
"parentSpaceKey": null
},
{
"spaceKey": "CN-152221100",
"spaceName": "科尔沁镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221101",
"spaceName": "索伦镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221102",
"spaceName": "徳伯斯镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221103",
"spaceName": "大石寨镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221104",
"spaceName": "归流河镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221105",
"spaceName": "居力很镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221106",
"spaceName": "察尔森镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221107",
"spaceName": "额尔格图镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221108",
"spaceName": "俄体镇",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221200",
"spaceName": "满族屯满族乡",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221201",
"spaceName": "乌兰毛都苏木",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221202",
"spaceName": "阿力得尔苏木",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221203",
"spaceName": "巴日嘎斯台乡",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221204",
"spaceName": "桃合木苏木",
"parentSpaceKey": "CN-152221"
},
{
"spaceKey": "CN-152221405",
"spaceName": "绿水种畜场",
"parentSpaceKey": "CN-152221"
}
],
"customSpaces": null
}
}
获取数据产品的数据时间列表

接口描述:

  • 使用tqDsCodespaceKey,来获取数据产品在对应空间范围的数据时间列表
  • 可将获取的时间列表做成时间轴组件,让用户在前端可自由切换时间查看不同时间的数据图层

请求URL:

请求方式:

  • POST

表头:

  • Host:<calculated when request is sent>
  • user-id:用户ID,与token相同
  • secret:身份认证码

参数:

参数名是否必填类型说明
serviceIdstring服务ID
spaceKeystring空间范围的标识
timeLineRequestVOstring服务下属空间的有效数据时间查询请求VO (View Object视图层对象,前端使用对象)
tqDsCodesstring数据产品编号 (可填写多个)
tqDsParentCodesstring关联的数据产品编号 (当一个数据产品包含关联的数据产品编号,请求时需要填写关联的数据产品编号才能获取到对应的数据)
timeRangeStartint查询数据开始时间 (秒级时间搓)。不填写会返回全量时间点
timeRangeEndint查询数据结束时间 (秒级时间搓)。不填写会返回全量时间点

输入示例

{
"serviceId": "e2434265-e297-46b0-a2a6-70e6a2d721fa",
"spaceKey": "CN-441704",
"timeLineRequestVO": {
"tqDsCodes": [
"der108.b",
"der108.c",
"der108.d"
],
"tqDsParentCodes": [
""
]
},
"timeRangeEnd": 1630425599,
"timeRangeStart": 1627747200
}

返回数据体

参数名说明
timeLines数据时间列表
timeLine数据时间
tqDsCode数据产品编号

返回示例

{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"success": true,
"processMsg": "finished",
"timeLines": [
{
"timeLine": [
"20210114",
"20210213",
"20210223",
"20210129",
"20210404",
"20210315",
"20210218",
"20210119",
"20210509",
"20210618"
],
"tqDsCode": "der108.b"
},
{
"timeLine": [
"20210213",
"20210114",
"20210223",
"20210129",
"20210404",
"20210315",
"20210218",
"20210119",
"20210509"
],
"tqDsCode": "der108.c"
},
{
"timeLine": [
"20210213",
"20210114",
"20210223",
"20210129",
"20210404",
"20210315",
"20210119",
"20210218",
"20210509"
],
"tqDsCode": "der108.d"
}
]
}
}
获取数据产品的特地图层及统计数据

接口描述:

  • 使用tqDsCodespaceKeytimeLine,来获取数据产品的特地图层 (dataFile)和统计数据 (databox)
  • 可根据前端的数据产品选择器组件、空间范围选择器组件、时间轴组件来动态获取需要展示的数据图层

请求URL:

请求方式:

  • POST

请求头:

  • Host:<calculated when request is sent>
  • user-id:用户ID,与token相同
  • secret:身份认证码

请求参数:

参数名是否必填数据类型说明
productTileRequestVOobject数据产品请求参数列表
tqDsCodesarray数据产品编号 (可填写多个)
tqDsParentCodesarray关联的数据产品编号 (当一个数据产品包含关联的数据产品编号,请求时需要填写关联的数据产品编号才能获取到对应的数据)
serviceIdstring服务ID
spaceKeystring空间范围的标识
timestamplong需要查询数据的时间点 (如果输入多个tqDsCode,则会返回查询的每个数据产品在查询时间点之前的最近一期图层数据)

输入示例1: (示例中获取的是矢量图层)

{
"productTileRequestVO": {
"tqDsCodes": [
"der101.d"
],
"tqDsParentCodes": [
"cor1010210"
]
},
"serviceId": "8a151451-fcb8-4eb1-b4a8-b814c1c448aa",
"spaceKey": "22c2b0a9-30d4-4f8b-8ea6-1206b79759da",
"timestamp": "1591027199"
}

返回数据体1:

参数名说明
tqDsCode数据产品编号
tqDsName数据产品的名称
databox数据产品的统计数据
area数据产品的面积 (单位:平方米)
cor_area数据产品的面积 (单位:平方米,目前和area无区别)
der_max数据产品属性的最大值
der_meanv数据产品属性的平均值
der_min数据产品属性的最小值
feature_count数据产品包含矢量的数量
percent数据产品占当前空间范围的面积占比
percentage数据产品占当前空间范围的面积占比 (目前与percent无区别)
tileData图层的相关数据
originalFile该数据产品的矢量图层原始连接,只针对矢量数据类型有效
batchType批次类型 (vector=矢量图层,raster=栅格图层)
serviceId服务ID
spaceKey空间范围的标识
parentTqDsCode关联的数据产品编号 (例如长势监测关联的数据产品可能是小麦或水稻,不同的关联TQDS对应的是不同的数据图层)
dataFile该数据产品的图层链接 (图层渲染示例请参考上方的“WMTS图层前端渲染示例”)
timestamp数据时间
maxZoom图层最大缩放层级 (超过最大层级的图层未切分瓦片,无瓦片数据)

返回示例1:


{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": [
{
"success": true,
"processMsg": "finished",
"tqDsCode": "der101.d",
"tqDsName": "干旱监测",
"databox": {
"area": "19317545.705",
"percentage": "0.014",
"feature_count": 433,
"der_min": "0.0",
"der_max": "0.973",
"der_meanv": "0.466",
"cor_area": null,
"percent": null
},
"tileData": {
"batchType": "vector",
"serviceId": "8a151451-fcb8-4eb1-b4a8-b814c1c448aa",
"spaceKey": "22c2b0a9-30d4-4f8b-8ea6-1206b79759da",
"parentTqDsCode": "cor1010210",
"dataFile": "https://dev-tile.terraqt.com/tile/xyz/{z}/{x}/{y}.pbf?path=8a151451-fcb8-4eb1-b4a8-b814c1c448aa/cor1010210/der101.d/202006/22c2b0a9-30d4-4f8b-8ea6-1206b79759da/vectortiles",
"originalFile": "https://dev-tile.terraqt.com/tile/geojson?path=8a151451-fcb8-4eb1-b4a8-b814c1c448aa/cor1010210/der101.d/202006/22c2b0a9-30d4-4f8b-8ea6-1206b79759da/vectortiles",
"timestamp": "202006",
"maxZoom": 14
}
}
]
}

输入示例2: (示例中获取的是栅格图层)

{
"productTileRequestVO": {
"tqDsCodes": [
"der108.b",
"der108.c"
],
"tqDsParentCodes": [
"cor1010210"
]
},
"serviceId": "e2434265-e297-46b0-a2a6-70e6a2d721fa",
"spaceKey": "CN-441704",
"timestamp": "1620489600"
}

返回数据体2:

参数名说明
tqDsCode数据产品编号
tqDsName数据产品的名称
databox数据产品的统计数据
area数据产品的面积 (单位:平方米)
cor_area数据产品的面积 (单位:平方米,目前和area无区别)
der_max数据产品属性的最大值
der_meanv数据产品属性的平均值
der_min数据产品属性的最小值
feature_count数据产品包含矢量的数量
percent数据产品占当前空间范围的面积占比
percentage数据产品占当前空间范围的面积占比 (目前与percent无区别)
tileData图层的相关数据
originalFile该数据产品的矢量图层原始连接,只针对矢量数据类型有效
batchType批次类型 (vector=矢量图层,raster=栅格图层)
serviceId服务ID
spaceKey空间范围的标识
parentTqDsCode关联的数据产品编号 (例如长势监测关联的数据产品可能是小麦或水稻,不同的关联TQDS对应的是不同的数据图层)
dataFile该数据产品的图层链接 (图层渲染示例请参考上方的“WMTS图层前端渲染示例”)
timestamp数据时间
maxZoom图层最大缩放层级 (超过最大层级的图层未切分瓦片,无瓦片数据)

返回示例2:


{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": [
{
"success": true,
"processMsg": "finished",
"tqDsCode": "der108.b",
"tqDsName": "水体透明度",
"databox": {
"area": null,
"percentage": null,
"feature_count": null,
"der_min": "0.0",
"der_max": "4.98",
"der_meanv": "1.24",
"cor_area": null,
"percent": null
},
"tileData": {
"batchType": "raster",
"serviceId": "e2434265-e297-46b0-a2a6-70e6a2d721fa",
"spaceKey": "CN-441704",
"parentTqDsCode": null,
"dataFile": "e2434265-e297-46b0-a2a6-70e6a2d721fa/der108.b/20210509/CN-441704/rastertiles",
"originalFile": null,
"timestamp": "20210509",
"maxZoom": 14
}
},
{
"success": true,
"processMsg": "finished",
"tqDsCode": "der108.c",
"tqDsName": "悬浮物浓度",
"databox": {
"area": null,
"percentage": null,
"feature_count": null,
"der_min": "0.314",
"der_max": "80.0",
"der_meanv": "12.807",
"cor_area": null,
"percent": null
},
"tileData": {
"batchType": "raster",
"serviceId": "e2434265-e297-46b0-a2a6-70e6a2d721fa",
"spaceKey": "CN-441704",
"parentTqDsCode": null,
"dataFile": "e2434265-e297-46b0-a2a6-70e6a2d721fa/der108.c/20210509/CN-441704/rastertiles",
"originalFile": null,
"timestamp": "20210509",
"maxZoom": 14
}
}
]
}