DB14 T 2258-2021 地震信息系统接口规范.pdf

1、ICS 90.120.25CCS A 44 DB14山 西 省 地 方 标 准DB 14/ T 2258 2021地 震 信 息 系 统 接 口 规 范 2021 -01- 12发 布 2021- 03-12实 施山 西 省 市 场 监 督 管 理 局 发 布 DB14/T 22582021 I 目 次前言 .II1 范围 .12 规范性引用文件 .13 术语和定义 .14 缩略语 .15 基本要求 .16 接口格式 .27 访问程序 .2 附录 A （资料性） 地震信息系统接口示例 .4附录 B （资料性） JSON格式示例 .5附录 C （资料性） 响应代码及响应消息 .6参考文献 .7

2、DB14/T 22582021 II 前 言本文件按照GB/T1.1 2020标准化工作导则 第 1 部分：标准化文件的结构和起草规则的规定起草。 本文件由山西省地震局提出并监督实施。本文件由山西省地震标准化技术专家组归口。本文件起草单位：山西省地震局监测信息中心。本文件主要起草人：黄金刚、张娜、王卓君、罗勇、高伟亮、梁永烨、殷伟伟、李晓锐、谷利国、陈存田、张甲瑞、高翔、刘俊芳、吕睿、王宁、闫晓美。 DB14/T 22582021 1 地震信息系统接口规范1 范围 本文件规定了地震信息系统接口的术语和定义、缩略语、基本要求、接口格式和访问程序。本文件适用于地震信息系统接口的设计和使用。2 规范

3、性引用文件 下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 GB/T 22568 2008 公共地震信息发布3 术语和定义 下列术语和定义适用于本文件。3.1 地震信息系统 Seismic information system向政府、社会和生产部门提供地震事件信息的软件系统。3.2 接口 Interface 一组定义、程序及协议的集合，通过接口实现计算机软件之间的相互通信。4 缩略语 下列缩略语适用于本文件。HTTP： 超文本传输协议（Hypertexttr

4、ansferprotocol ）IP：互联网协议（InternetProtocol ）URL：统一资源定位符（ UniformResourceLocator）JSON： 数据交换格式（JavaScriptObjectNotation ）UTF-8：针对 Unicode的可变长度字符编码（ 8-bitUnicodeTransformationFormat）5 基本要求 5.1 通用要求 DB14/T 22582021 2 5.1.1 用户应申请注册用户名和密码，支持验证。5.1.2 接口通过加密算法对用户进行授权；接口请求参数按照顺序拼接成字符串，加上时间戳（格式为 YYYYMMDDHHMM）形

5、成新的字符串，对新字符串中的 MD5消息摘要算法的 32 位加密，形成 Key值。其中，YYYY表示年（4位），MM 表示月（2 位），DD表示日（2 位），HH表示时（2位），MM 表示分（2位）。5.1.3 系统应提供接口说明。接口说明包括地震信息系统接口描述、调用请求方式、参数说明、常用参数代码等内容，并给出接口调用示例代码。5.2 服务请求参数要求地震信息系统接口服务请求参数要求见表1。 表 1 服务请求参数要求 参数 格式 备注时间参数 YYYY-MM-DDHH:mm:ss 中华人民共和国北京时间，YYYY 表示年（4 位），MM表示月（2 位）， DD表示日（2 位）， HH表示小

6、时（2 位，24 小时制），mm 表示分钟（2 位），ss表示秒钟（2 位）。年月日使用短横线（-）为分隔符分隔，时分秒使用冒号（: ）为分隔符分隔，年月日与时分秒间间隔一个空格。位置参数 经度 XXX.XX度 地理经纬度，XXX.XX 表示整数 3位，小数 2位；XX.XX表示：整数 2位，小数 2位。纬度 XX.XX度 震级参数 X.X级 使用 GB17740-1999中规定的地震震级 M， X.X表示：整数 1位，小数 1位。5.3 效能要求地震信息系统接口应提供多用户并行访问支持，响应时间应小于 500ms。6 接口格式6.1 接口访问地址：接口访问地址应采用统一资源定位符（URL）。

7、6.2 接口协议： HTTP协议 POST方式。6.3 调用参数：包括时间参数、位置参数、震级参数等。6.4 响应参数：包括响应代码、响应消息和数据体三部分。 6.5 地震信息系统接口示例参见附录 A。7 访问程序7.1 访问地址地震信息系统接口访问地址应采用统一资源定位符（URL）。URL中的服务器地址宜采用域名，不宜采用IP地址。 DB14/T 22582021 3 7.2 访问步骤7.2.1 注册用户应通过地震信息系统接口单位提供的地震服务数据系统平台（以下简称“平台”）申请注册用户名和密码。或应由地震信息系统接口单位给用户在平台上创建用户名和密码。7.2.2 登陆用户通过用户名和密码登

8、陆平台，申请地震信息系统接口访问账号APPID和地震信息系统接口访问密钥Key（Key应具有有效期，有效期内用户可重复使用，超过有效期系统为用户重新生成Key值） 。7.2.3 获取接口地址用户通过用户名和密码登陆平台，获取地震信息系统接口资源访问地址。 7.2.4 生成请求地址用户应在地震数据资源地址中加入APPID和Key，形式为“&appid=&key=”,生成服务资源请求地址。7.2.5 获取服务响应用户采用HTTP协议中的POST方法调用地震数据资源请求地址，获取服务响应。7.3 服务响应7.3.1 返回格式返回格式要求见表2。 表 2 返回格式要求 7.3.2 返回结果编码返回结果

9、编码采用UTF-8字符集。 A参数 格式 备注返回结果 JSON格式 JSON格式示例见附录 B响应代码 resCode 整数型 响应代码参见附录 C响应消息 resMsg 字符型 返回内容应为响应代码的详细说明（响应消息参 见附录 C）数据体 data 数组型 返回内容应为地震数据的具体描述 DB14/T 22582021 4 附 录 A（资料性）地震信息系统接口示例表A.1给出了地震信息系统接口示例。 表 A.1 地震信息系统接口示例接口名称 地震参数获取接口服务资源请求地 址 http:/domain/api/eq_catelog_neweq&appid=xyz789&key=01ff3

10、3x67fd67988sm8892hg&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”：“2020030212083

11、0 ”，“location ”: “山西阳曲” ，“city ” :“太原市”，“city_code ” :“0351 ”，“ lon” :“ 37.86”，“ lat” :“112.55 ”，“ M” :“ 1.3”，“depth ” :“ 10”，“ o_time”：“20200302120830 ”， “location ”: “山西阳曲”注：以山西太原市阳曲县M1.3地震地震参数为例 DB14/T 22582021 5 AB附 录 B（资料性）JSON格式示例JSON格式： “resCode”:“”，“resMsg”:“”，“data”: 表B.1给出了JSON格式返回数据示例要求。

12、表 B.1 JSON格式示例要求名称 数据类型 说明resCode 整数型Int 响应代码resMsg 字符型String 响应消息 data 数组型Array 数据体 DB14/T 22582021 6 BC附 录 C（资料性）响应代码及响应消息表C.1给出了响应代码及响应消息的要求。 表 C.1 响应代码及响应消息序号 响应代码 响应消息 1 000 获取成功2 101 APPID不存在或Key 错误3 102 接口权限不足4 103 服务不存在5 104 非法请求6 105 APPID当前被禁用7 106 账号未登录8 201 APPID、Key 不能为空9 202 参数不足10 203

13、 参数含非法字符11 204 参数错误 12 205 账号不存在或密码错误13 302 数据解析出错14 303 资源不存在15 304 配置解析出错16 305 资源服务器异常17 306 数据库异常18 401 未知异常 DB14/T 22582021 7 参 考 文 献1 GB 177401999 地震震级的规定2 YD/T 32142017 互联网资源协作服务信息安全管理系统接口规范3 DB11/T 1309.32017 网格化社会服务管理信息系统技术规范 第3部分：通用数据接口4 DB41/T 18092019 气象服务信息数据接口规范5 DB37/T 2930-2017 气象服务信息数据接口规范6 RFC 2616 超文本传输协议（Hypertext Transfer Protocol）_