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

ICS90.120.25CCSA44DB14山西省市场监督管理局发布IDB14/T2258—2021前言 12规范性引用文件 13术语和定义 14缩略语 15基本要求 16接口格式 27访问程序 2附录A（资料性）地震信息系统接口示例 4附录B（资料性）JSON格式示例 5附录C（资料性）响应代码及响应消息 6参考文献 7DB14/T2258—2021本文件按照GB/T1.1－2020《标准化工作导则第1部分：标准化文件的结构和起草规则》的规定起草。本文件由山西省地震局提出并监督实施。本文件由山西省地震标准化技术专家组归口。本文件起草单位：山西省地震局监测信息中心。本文件主要起草人：黄金刚、张娜、王卓君、罗勇、高伟亮、梁永烨、殷伟伟、李晓锐、谷利国、陈存田、张甲瑞、高翔、刘俊芳、吕睿、王宁、闫晓美。1DB14/T2258—2021地震信息系统接口规范本文件规定了地震信息系统接口的术语和定义、缩略语、基本要求、接口格式和访问程序。本文件适用于地震信息系统接口的设计和使用。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通用要求2DB14/T2258—20215.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服务请求参数要求），），ss表示秒钟（2位）。年月日使用短横线（-）为分隔符分隔，时分秒使用冒号（:）为分隔符分隔，年5.3效能要求地震信息系统接口应提供多用户并行访问支持，响应时间应小于500ms。6接口格式6.1接口访问地址：接口访问地址应采用统一资源定位符（URL）。6.2接口协议：HTTP协议POST方式。6.3调用参数：包括时间参数、位置参数、震级参数等。6.4响应参数：包括响应代码、响应消息和数据体三部分。6.5地震信息系统接口示例参见附录A。7访问程序7.1访问地址地震信息系统接口访问地址应采用统一资源定位符（URL）。URL中的服务器地址宜采用域名，不宜采用IP地址。3DB14/T2258—20217.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返回格式要求7.3.2返回结果编码返回结果编码采用UTF-8字符集。4DB14/T2258—2021（资料性）地震信息系统接口示例表A.1给出了地震信息系统接口示例。表A.1地震信息系统接口示例址http://domain/api/eq_catelog_neweq&appid=xyz789&key=01ff33x67fd67988}5DB14/T2258—2021JSON格式示例JSON格式：“resMsg”:“…”，“data”:{……]}表B.1给出了JSON格式返回数据示例要求。表B.1JSON格式示例要求resCode6DB14/T2258—2021（资料性）响应代码及响应消息表C.1给出了响应代码及响应消息的要求。表C.1响应代码及响应消息1234567897DB14/T2258—2021参考文献[1]GB17740—1999地震震级的规定[2]YD/T3214—2017互联网资源协作服务信息安全管理系统接口规范[3]DB11/T1309.3—2017网格化社会服务管理信息