文档

创建空间服务API

更新时间:

通过将空间数据管理中的各类型空间数据发布成行业标准的空间服务API,以便后续调用,减少资源操作成本。本文介绍如何创建空间服务API。

前提条件

已创建应用,具体操作,请参见新建应用

操作步骤

  1. 登录数据资源平台控制台

  2. 在页面左上角,单击导航图标 图标,选择协同

  3. 在顶部菜单栏,单击选择工作组图标,选择目标工作组,单击资产加工

  4. 在左侧导航栏,单击API图标,选择API开发 > 空间服务API

  5. 空间服务API页面,单击代理服务管理

  6. 空间代理服务API页面右上角,单击创建API

  7. 空间代理服务API-创建页面,开始新建API。

    1. 设置API基础信息。

      名称

      说明

      API名称

      需创建API的名称,自定义。

      所属应用

      API的归属应用,自定义创建,支持在系统设置模块和创建API页面新增应用,关于新建应用,更多请参见新建应用

      服务类型

      支持多种服务类型。

      • OGC WFS服务:地图服务、地理数据服务,符合OGC Web要素服务 (WFS) 规范。

      • OGC WMS服务:地图服务、影像服务,符合OGC Web地图服务 (WMS) 规范。

      • OGC WMTS服务:地图服务、影像服务,符合OGC Web地图切片服务 (WMTS)规范的服务。

      • SuperMap REST服务:超图地图服务,SuperMap工作空间数据。

      • ArcGIS REST服务:地图服务。

      • 其他GIS服务:除以上这些服务外的GIS服务。

      服务URL

      联系对应提供商获取。

      说明

      URL地址示例:http://example.com/login

      API Path

      API调用时展示的固定路径,默认自动生成。

      调用认证方式

      简单身份认证加密身份认证两种方式,更多信息,请参见认证方式说明

      • 简单身份认证:适用于工作组内、测试等场景下的API调用,工作组内调用时用API归属应用的AppCode调用。

      • 加密身份认证:通过加密算法计算一个签名并放在请求的Header中即可调用API,具备更高的安全性,适用于API共享后,应用开发场景下API的调用。

      标签

      自定义,可选。

      描述

      针对该API增加的描述信息,自定义,必选。

      空间数据元信息

      坐标系

      需创建API坐标系。

      投影类型

      支持墨卡托、高斯-克吕格、web-墨卡托、UTM、经纬度和其他。

      覆盖范围

      需创建API覆盖范围,包括全球,全国、省、市县和其他,可选。

      数据范围

      左上角经度

      输入左上角经度的坐标范围。

      左上角纬度

      输入左上角纬度的坐标范围。

      右下角经度

      输入右下角经度的坐标范围。

      右下角纬度

      输入右下角纬度的坐标范围。

      服务提供者信息

      服务提供者的信息。

    2. 参数配置区域,配置API参数。

      参数

      说明

      服务资源组

      选择服务资源组,上线后API的测试和调用会占用资源组,请根据资源组的规格和占用情况,选择适合的服务资源组。

      过滤器

      (可选)打开过滤器开关,设置信息模块展示隐藏,更多信息,请参见API结果过滤器

    3. 测试API:单击开始测试,核对返回内容。

    4. 配置API流量控制。

      参数

      说明

      API最大调用QPS

      API最大调用QPS应为不大于10000的正整数。当服务资源组设置为“公共资源组”时,API最大调用QPS只能为1。更多信息,请参考API流量控制支持的参数

      超时配置

      请选择API单次响应超时时间。当服务资源组设置为“公共资源组”时,API单次响应超时时间限制,最大支持10s。

      开启缓存

      打开开启缓存开关,API调用会请求缓存。

      缓存时长

      当缓存开启后,可以手动设置缓存失效时间,缓存时长上限为3600秒。

  8. API参数配置完成后,单击保存保存并上线

    在API资源列表,可查看新建的API。

相关操作

操作

说明

编辑API

在API资源列表中,单击目标API操作列的编辑,在API编辑向导页面,可对API进行编辑修改。

说明

编辑API参数配置中的云计算资源时,需要查看当前使用表中字段是否与编辑前使用表中的字段存在部分一致,如果一致可能导致编辑完成后,编辑内容不生效。

复制API

在API资源列表操作列,选择更多 > 复制,在API资源列表中生成一个新的草稿API。单击复制API操作列的编辑,对复制的API进行编辑修改。

删除API

在API资源列表操作列,选择更多 > 删除,在删除对话框中,单击确定

说明

已上线的API不支持删除。

后续步骤

API创建完成后,需要对API进行上线操作,具体操作,请参见上线API

  • 本页导读 (0)
文档反馈