DB14∕T 2258-2021 地震信息系统接口规范_第1页
DB14∕T 2258-2021 地震信息系统接口规范_第2页
DB14∕T 2258-2021 地震信息系统接口规范_第3页
DB14∕T 2258-2021 地震信息系统接口规范_第4页
DB14∕T 2258-2021 地震信息系统接口规范_第5页
免费预览已结束,剩余5页可下载查看

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

ICS90.120.25

CCSA44

DB14

山西省地方标准

DB14/T2258—2021

地震信息系统接口规范

2021-01-12发布2021-03-12实施

山西省市场监督管理局发布

DB14/T2258—2021

目  次

前言.....................................................................................................................................................................II

1范围.................................................................................................................................................................1

2规范性引用文件.............................................................................................................................................1

3术语和定义.....................................................................................................................................................1

4缩略语.............................................................................................................................................................1

5基本要求.........................................................................................................................................................1

6接口格式.........................................................................................................................................................2

7访问程序.........................................................................................................................................................2

附录A(资料性)地震信息系统接口示例...............................................................................................4

附录B(资料性)JSON格式示例...............................................................................................................5

附录C(资料性)响应代码及响应消息...................................................................................................6

参考文献...............................................................................................................................................................7

I

DB14/T2258—2021

前  言

本文件按照GB/T1.1-2020《标准化工作导则第1部分:标准化文件的结构和起草规则》的规定

起草。

本文件由山西省地震局提出并监督实施。

本文件由山西省地震标准化技术专家组归口。

本文件起草单位:山西省地震局监测信息中心。

本文件主要起草人:黄金刚、张娜、王卓君、罗勇、高伟亮、梁永烨、殷伟伟、李晓锐、谷利国、

陈存田、张甲瑞、高翔、刘俊芳、吕睿、王宁、闫晓美。

II

DB14/T2258—2021

地震信息系统接口规范

1范围

本文件规定了地震信息系统接口的术语和定义、缩略语、基本要求、接口格式和访问程序。

本文件适用于地震信息系统接口的设计和使用。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,

仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本

文件。

GB/T22568—2008公共地震信息发布

3术语和定义

下列术语和定义适用于本文件。

3.1

地震信息系统Seismicinformationsystem

向政府、社会和生产部门提供地震事件信息的软件系统。

3.2

接口Interface

一组定义、程序及协议的集合,通过接口实现计算机软件之间的相互通信。

4缩略语

下列缩略语适用于本文件。

HTTP:超文本传输协议(Hypertexttransferprotocol)

IP:互联网协议(InternetProtocol)

URL:统一资源定位符(UniformResourceLocator)

JSON:数据交换格式(JavaScriptObjectNotation)

UTF-8:针对Unicode的可变长度字符编码(8-bitUnicodeTransformationFormat)

5基本要求

5.1通用要求

1

DB14/T2258—2021

5.1.1用户应申请注册用户名和密码,支持验证。

5.1.2接口通过加密算法对用户进行授权;接口请求参数按照顺序拼接成字符串,加上时间戳(格式

为YYYYMMDDHHMM)形成新的字符串,对新字符串中的MD5消息摘要算法的32位加密,形成Key值。其

中,YYYY表示年(4位),MM表示月(2位),DD表示日(2位),HH表示时(2位),MM表示分(2

位)。

5.1.3系统应提供接口说明。接口说明包括地震信息系统接口描述、调用请求方式、参数说明、常用

参数代码等内容,并给出接口调用示例代码。

5.2服务请求参数要求

地震信息系统接口服务请求参数要求见表1。

表1服务请求参数要求

参数格式备注

中华人民共和国北京时间,YYYY表示年(4位),

MM表示月(2位),DD表示日(2位),HH表示

YYYY-MM-DD小时(2位,24小时制),mm表示分钟(2位),

时间参数

HH:mm:ssss表示秒钟(2位)。年月日使用短横线(-)为分

隔符分隔,时分秒使用冒号(:)为分隔符分隔,年

月日与时分秒间间隔一个空格。

地理经纬度,表示整数位,小数位;

经度XXX.XX度XXX.XX32

位置参数XX.XX表示:整数2位,小数2位。

纬度XX.XX度

使用GB17740-1999中规定的地震震级M,X.X表

震级参数X.X级

示:整数1位,小数1位。

5.3效能要求

地震信息系统接口应提供多用户并行访问支持,响应时间应小于500ms。

6接口格式

6.1接口访问地址:接口访问地址应采用统一资源定位符(URL)。

6.2接口协议:HTTP协议POST方式。

6.3调用参数:包括时间参数、位置参数、震级参数等。

6.4响应参数:包括响应代码、响应消息和数据体三部分。

6.5地震信息系统接口示例参见附录A。

7访问程序

7.1访问地址

地震信息系统接口访问地址应采用统一资源定位符(URL)。URL中的服务器地址宜采用域名,不宜

采用IP地址。

2

DB14/T2258—2021

7.2访问步骤

7.2.1注册

用户应通过地震信息系统接口单位提供的地震服务数据系统平台(以下简称“平台”)申请注册用

户名和密码。或应由地震信息系统接口单位给用户在平台上创建用户名和密码。

7.2.2登陆

用户通过用户名和密码登陆平台,申请地震信息系统接口访问账号APPID和地震信息系统接口访问

密钥Key(Key应具有有效期,有效期内用户可重复使用,超过有效期系统为用户重新生成Key值)。

7.2.3获取接口地址

用户通过用户名和密码登陆平台,获取地震信息系统接口资源访问地址。

7.2.4生成请求地址

用户应在地震数据资源地址中加入APPID和Key,形式为“&appid=<APPID>&key=<Key>”,生成服务

资源请求地址。

7.2.5获取服务响应

用户采用HTTP协议中的POST方法调用地震数据资源请求地址,获取服务响应。

7.3服务响应

7.3.1返回格式

返回格式要求见表2。

表2返回格式要求

参数格式备注

返回结果JSON格式JSON格式示例见附录B

响应代码resCode整数型响应代码参见附录C

返回内容应为响应代码的详细说明(响应消息参

响应消息resMsg字符型

见附录C)

数据体data数组型返回内容应为地震数据的具体描述

7.3.2返回结果编码

返回结果编码采用UTF-8字符集。

A

3

DB14/T2258—2021

附录A

(资料性)

地震信息系统接口示例

表A.1给出了地震信息系统接口示例。

表A.1地震信息系统接口示例

接口名称地震参数获取

接口服务资源请求地http://domain/api/eq_catelog_neweq&appid=xyz789&key=01ff33x67fd67988sm8

址892hg&daystart=20200102&days=-1

appid:用户应用ID(申请用户时获取)

key:应用秘钥

参数说明

daystart:起始时间

days:天数累计(如:-1,-2,-4,-30)

{“resCode”:“000”,

“resMsg”:“数据获取成功”,

“data”:{

[{“city”:“太原市”,“city_code”:“0351”,“lon”:“37.86”,“lat”:

“112.55”,“M”:“1.3”,“depth”:“10”,“o_time”:“20200302120830”,

返回结果“location”:“山西阳曲”},

{“city”:“太原市”,“city_code”:“0351”,“lon”:“37.86”,“lat”:

“112.55”,“M”:“1.3”,“depth”:“10”,“o_time”:“20200302120830”,

“location”:“山西阳曲”}

]}

}

注:以山西太原市阳曲县M1.3地震地震参数为例

4

DB14/T2258—2021

BA

附录B

(资料性)

JSON格式示例

JSON格式:

{“resCode”:“…”,

“resMsg”:“…”,

“data”:{

[

]

}

}

表B.1给出了JSON格式返回数据示例要求。

表B.1JSON格式示例要求

名称数据类型说明

resCode整数型Int响应代码

resMsg字符型String响应消息

data数组型Array数据体

5

DB14/T2258—2021

CB

附录C

(资料性)

响应代码及响应消息

表C.1给出了响应代码及响应消息的要求。

表C.1响应代码及响应消息

序号响应代码响应消息

1000获取成功

2101APPID不存在或Key错误

3102接口权限不足

4103服务不存在

5104非法请求

6105APPID当前被禁用

7106账号未登录

8201APPID、Key不能为空

9202参数不足

10203参数含非法字符

11204参数错误

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论