标准规范下载简介

Q／CR 821-2021 铁路数据服务平台接口规范.pdf简介：

Q／CR 821-2021 是中国铁路总公司发布的一项关于铁路数据服务平台接口规范的标准，全称为《铁路数据服务平台接口规范》。这个规范主要是为了统一和规范铁路数据的接口设计，使得不同系统之间、内外部系统之间的数据交换和共享变得更加高效和便捷。

该规范主要包括以下几个方面：

1. 接口设计原则：它规定了接口设计应遵循的原则，如简洁性、可扩展性、可维护性、安全性等，以保证接口的易用性和稳定性。

2. 接口类型：明确了接口的种类，如RESTful API、SOAP接口等，以及数据格式，如JSON、XML等。

3. 数据格式：规定了数据的结构和格式，包括数据的获取、创建、更新和删除等操作的响应格式。

4. 安全机制：强调了数据传输的安全性，如API密钥管理、HTTPS通信、访问控制等。

5. 错误处理：定义了接口调用失败时的错误码、错误信息等，便于开发者理解和处理。

6. 版本控制：规定了接口的版本管理机制，确保新版本接口的更新不会对已有的系统造成影响。

通过这个规范，铁路数据服务平台可以提供统一、稳定、易用的接口给所有接入方，推动铁路信息化和数据共享的进程。

Q／CR 821-2021 铁路数据服务平台接口规范.pdf部分内容预览：

消息的发送者messagesender 产生消息的应用程序 [来源：GB/T28168—2011,3.1.3 3.6 消息的接收者messagereceiver 接收消息的应用程序。 「来源：GB/T28168—2011.3.1.4

下列缩略语适用于本文件。 HTTP：超文本传输协议（HyperText TransferProtocol) JSON：JavaScript对象标记（JavaScript ObjectNotation） REST：表述性状态传递（RepresentationalStateTransfer） SFTP：安全文件传送协议（SSHFileTransferProtocol)

接口a、b是铁路数据服务平台与铁路信息系统之间的文件交换方式接口；铁路信息系统从铁路 服务平台获取认证信息（authorization），传输数据时宜通过加密算法进行数据加密传输。

公路桥梁抗震设计规范JTGT 2231-01 —20206.2接口a（文件接收）

采用SFTP协议进行文件交换时，获取SFTP配置信息的接口名称为“sftpInfo”，请求方式为 "POST"，输入参数应符合表1的规定，调用成功返回信息应符合表2的规定，调用失败返回信息应符合 表3的规定

表2调用成功返回信息表

采用SFTP协议进行文件交换时，获取SFTP配置信息的接口名称为“sftplnfo”，请求方 “POST"，输人参数应符合表1的规定，调用成功返回信息应符合表2的规定，调用失败返回信息应 表3的规定

web服务方式接口分为接口c服务发布和接口d服务调用。服务发布接口分为结构化数据导入和 接口、非结构化数据导入和共享接口，服务调用接口分为结构化数据和非结构化数据的导人接口 web服务方式接口宜采用Rest协议进行传输。 返回结果的错误信息应符合附录A的规定。

7.2.1结构化数据导入

采用Rest协议进行数据传输时，数据导入接口名称为“datason”，请求方式为“POST”，输入参数应 符合表4的规定，调用成功返回信息应符合表5的规定，调用失败返回信息应符合表6的规定。传输的 数据应符合附录B的规定

表6 调用失败返回信息表

采用Rest协议进行数据传输时，数据共享的接口名称为“queryData”，请求方式为“POST”，输入参 符合表7的规定，调用成功返回信息应符合表8的规定，调用失败返回信息应符合表9的规定。 传 数据应符合附录B的规定

表12调用失败返回信息表

7.2.4.1获取文件的目录信息

用Rest协议进行数据传输时，获取文件目录下所有文件夹及文件的元数据信息的接口名称为 talogInfo”，请求方式为“POST”，输入参数应符合表13的规定，调用成功返回信息应符合表14的 周用失败返回信息应符合表15的规定。传输的数据应符合附录B的规定。

表14调用成功返回信息表

表15调用失败返回信息表

采用Rest协议进行数据传输时，获取文件的接口名称为“fetchFile”，请求方式为“GET"，输人参数 合表16的规定，调用成功返回信息应符合表17的规定，调用失败返回信息应符合表18的规定

表17调用成功返回信

采用Rest协议进行数据传输时，获取文件对应的MD5信息的接口名称为“fetchFileMd5”，请求方

式为“GET”，输人参数应符合表19的规定，调用成功返回信息应符合表20的规定，调用失败返回信息 应符合表21的规定

表20调用成功返回信息表

表21调用失败返回信息表

采用Rest协议进行数据传输时，数据导入接口名称为"structDataimpor”，其他要求应符合7.2.1的 规定。

采用Rest协议进行数据传输时， unstructDataimpor”，其他要求应符合7.2.3 的规定

消息队列方式接口宜采用kafka、MQ等中间件进行传输，返回结果的错误信息应符 规定。

8.2接口e（消息生产）

基于kafka的消息队列方式的接口进行数据传输时，获取消息队列生产者配置信息的接口名 “kafkaProducerlnfo”，请求方式为“POST”，输人参数应符合表22的规定，调用成功返回信息应 表23的规定，调用失败返回信息应符合表24的规定

表23调用成功返回信

DBJ04∕T 407-2020 住宅区和住宅建筑内光纤到户通信设施工程技术标准表24调用失败返回信息表

基于kafka的消息队列方式的接口进行数据传输时，获取消费者配置信息的接口名称为 kafkaConsumerlnfo”，请求方式为“POST”，输入参数应符合表25的规定，调用成功返回信息应符合 表26的规定，调用失败返回信息应符合表27的规定

表27调用失败返回信

错误信息应符合表A.1的规定

表A.1错误信息列表

附录B （规范性） 数据格式

[1]GB/T32908一2016非结构化数据访问接口规范 [2]GB/T36345—2018信息技术通用数据导人接口

GB／T 16508.4-2022 锅壳 锅炉 第4部分：制造、检验与验收.pdf[1]GB/T32908—2016非结构化数据访问接口规范 [2]GB/T36345—2018信息技术通用数据导人接口

中国国家铁路集团有限公司 企业标准 铁路数据服务平台接口规范 Interface specification of railway data service platform Q/CR821—2021 市 中国铁道出版社有限公司出版 (100054，北京市西城区右安门西街8号） 北京建宏印刷有限公司印刷 版权专有侵权必究 ★ 开本：880mmx1230mm1/16印张：1.25字数：23千字 2021年6月第1版2021年6月第1次印刷 萧 统一书号：15113·6292（内部用书）