CooServer 6.7 API 说明

一、获取加密公钥

说明

在向 CooServer 申请授权认证时,需要传用户名、密码参数,开发中需要使用公钥对密码进行 RSA 加密。

 

接口地址

 

请求参数说明

参数是否必须说明
clientId对接 CooServer 系统的账号

 

clientId 可在后台【系统设置】-【子系统管理】中查看:

image-20200409195542880

 

返回响应

正常情况下,会返回下述 JSON 数据包:

 

返回参数说明

返回字段说明
retCode返回码,0 表示请求成功
msg返回结果描述
data公钥字符串

 

二、申请令牌

说明

access_token 是 CooServer 的全局唯一接口调用凭据,调用 CooServer 各接口时都需使用access_token。开发者需要进行妥善保存。access_token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的 access_token 失效。

 

接口地址

 

请求参数

参数是否必须说明
username用户名
password用户密码,需要使用公钥对其 RSA 加密
grant_type固定设为 password

 

RSA 加密方法

 

请求头参数

参数是否必须说明
AuthorizationBasic + 空格 + base64(客户端账号:客户端密码)

 

返回响应

正常情况下,会返回下述 JSON 数据包:

 

返回参数说明

返回字段说明
access_token访问令牌
token_type令牌类型
expires_in过期时间,单位秒
scope权限范围

 

三、获取当前用户信息

说明

获取当前登录用户的详细信息。

 

接口地址

 

请求参数

参数是否必须说明
access_token访问令牌

 

返回响应

正常情况下,会返回下述 JSON 数据包:

 

返回参数说明

返回字段说明
retCode返回码,0 表示请求成功
msg返回结果描述
data用户数据
id用户 ID
username用户名
realName真实姓名
remark备注
mobile手机号
email邮箱
createTime创建时间
updateTime更新时间

 

四、获取子系统菜单

说明

获取子系统的菜单列表,子系统的菜单可以在 CooRunServer 中【权限管理】-【资源管理】-【菜单管理】中选择对应的子系统后,进行添加。

 

接口地址

 

请求参数

参数是否必须说明
oauthClientId客户端账号客户端账号
pid父菜单ID
access_token访问令牌

 

返回响应

正常情况下,会返回下述 JSON 数据包:

 

返回参数说明

返回字段说明
retCode返回码,0 表示请求成功
msg返回结果描述
data菜单数据
id菜单 ID
menuName菜单名称
menuUrl菜单 url
menuIcon菜单图标
pid父菜单 ID
leaf是否为叶子节点,0 表示否,1表示是
children子菜单列表

 

五、获取专题组织列表接口

说明

获取全部专题组织的树结构列表接口。

 

请求地址

 

请求参数

参数是否必须说明
groupType专题组织类型(0:基础服务,1:专题服务)
access_token访问令牌

 

返回响应

正常情况下,会返回下述 JSON 数据包:

 

返回参数说明

返回字段说明
retCode返回码,0 表示请求成功
msg返回结果描述
data专题组织数据
id专题组织 ID
groupName专题组织名称
groupType专题组织类型(0:基础,1:专题)
bizFlag业务标识
treeId树结构 ID
groupStatus专题组织状态(0:停止,1:开启)
userId发布者 ID
username发布者名称
orgId机构 ID
createTime创建时间,格式 yyyy-MM-dd HH:mm:ss
updateTime更新时间,格式 yyyy-MM-dd HH:mm:ss
batchNumber批次号
areaCode区域编码
list专题组织树结构
id树节点 ID
bizId业务 ID
layerId图层资源 ID
createTime创建时间,格式 yyyy-MM-dd HH:mm:ss
treeType树类型(0:批次发布,1:手动组织)
cid子节点 ID
pid父节点 ID(-1 为顶层节点)
name节点名称
isParent是否为文件夹(0:否,1:是)
openOrClose样式开合(0:合起,1:开启)
icon图标路径
serviceType节点服务类型
visible是否默认显示(0:否,1:是)
orgId机构 ID

 

六、获取三维图层服务

说明

根据图层 ID 和 access_token,获取三维图层服务数据。

 

请求地址

 

请求参数

参数是否必须说明
resource_id图层 ID
access_token访问令牌

 

返回响应

 

返回参数说明

返回字段说明
retCode返回码,0 表示请求成功
msg返回结果描述
data三维图层服务数据
id三维图层服务 ID
bizKey业务标识
userId用户 ID
serviceName服务名
serviceType服务类型(GMS、OSGB、DOM、DEM、BIM等)
dataServerHost文件服务器地址
dataPath数据绝对路径
areaCode区域编码
dataTime数据生产的时间,格式:yyyyMMdd
publishType发布方式(0:单条发布,1:批量发布,2:第三方服务)
serviceStatus服务状态(0:停止,1:开启)
username发布者名称
orgId发布的机构
createTime服务创建时间,格式 yyyy-MM-dd HH:mm:ss
updateTime服务更新时间,格式 yyyy-MM-dd HH:mm:ss
dataTypeCode数据类型
batchNumber批次编号
list三维图层数据列表
id三维图层数据 ID
bizKey业务标识
serviceName服务名称
path图层数据路径
compressed是否压缩(0:否,1:是)
c3s是否为c3s(0:否,1:是)
createTime创建时间,格式 yyyy-MM-dd HH:mm:ss
attr属性信息列表
id属性信息 ID
bizKey业务标识
attrType属性类型(0:基础属性,1:扩展属性)
attrKey属性名称
attrValue属性值
attrStatus状态(0:停用,1:启用)
attrRank排序
attrPrivilege权重
serviceType服务类型(GMS、OSGB、DOM、DEM、BIM等)

 

七、获取二维图层服务

说明

根据图层 ID 和 access_token,获取二维图层服务数据。

 

请求地址

 

请求参数

参数是否必须说明
resource_id专题组织类型(0:基础服务,1:专题服务)
access_token访问令牌

 

返回响应

 

返回参数说明

返回字段说明
retCode返回码,0 表示请求成功
msg返回结果描述
data二维图层服务数据
id二维图层服务 ID
bizKey业务标识
userId用户 ID
serviceUrl服务地址
serviceName服务名
ename服务别名
serviceStatus服务状态(0:停止,1:开启)
dataSource数据来源(0:arcgis,1:geoserver)
dataType数据类型(0:点,1:线,2:面)
workSpace工作区
uniqueField二维服务获取属性的必填字段
areaCode区域编码
bizFlag业务字段
topic是否配置专题(0:否,1:是)
dataTime数据生产的时间,格式 yyyyMMdd
username发布者名称
orgId发布的机构
createTime创建时间,格式 yyyy-MM-dd HH:mm:ss
updateTime更新时间,格式 yyyy-MM-dd HH:mm:ss
ogcTypeogc类型(0:wms,1:wfs,2:wmts)