SZSD01 0005—2024公交数据平台接口技术规范.docx
前aIi1范例12规范性引用文件3通用技术要求3-1接口构成32接口技术要求33接11协议要求3.4接口会话要求4不同类型接口技术要求4.1服务初始化接口42数据交换接口24.3交易接口34,4公共参数要求5参考文IW6本文件按照GB/T1.1-2020标准化工作导则第1部分:标准化文件的结构和起草规则3的规定起草.请注意本文件的某些内容可能涉及专利.本文件的发布机构不承担识别专利的责任.本文件由济南市大数据局提出并归口.本文件起点单位:济两市城市交通研究中心有限公司、济南公共交通集团有限公司、杭州效知梦科技有限公司、山东交通学院.本文件主要起草人:何伟、李峰、周欣、吴存钱、王逢宝、吴磊、王瑞利、何帧顺、杜元正、裳凯、赵南哲、刘蛭姨、何昆仑、负欣、张解、吴玉荣、徐碧藩、崔浩然、田用.公交数据平台接口技术规范1黄国本文件规定了公交数据平台接口的通用技术要求和不同类型接口技术要求.本文件适用于公交数据平台接口的设计、实施“2规楚性引用文件下列文件中的内衣通过文中的规范性引用而构成本文件必不可少的条款.其中,注日期的引用文件,仅该H期对应的版本适用干本文件:不注H期的引用文件.其最新版本(包括所有的修改单)适用于本文件.GB/T2312信息交换用汉字编码字符集3通用技术要求3.1接口构成公交数据平台的接口包括服务初始化接口'数据交换接口、交易接I.交易接口包括银联卡交易记录接口、实体卡交易记录接口、支付宝交易接口、微信乘车交劫记录接口、美团交易记录接口等。32接口技术要求接口应符合以下要求:Q至少提供JuS和Beb服务接II:b)支持跨语言、踏操作系统调用;C)数掘提供者注册数据接口位置:d)数据提供者发布接口使用说明:e)数据提供者建立接【1返【可值与数据项的对应关系.33接口协议要求3.3.1接口协议应使用无参数的HttPPoSt方式.每个交换消息(包括请求和应答)应以X«.格式表达。3.3.2所有请求报文应以<Request><Request>为XM1.的根元素,所有返I可报文应以<RcspOnSeX/Rcspunse>为XM1.的根元素。请求、返回批文中均应包含FUnC1.iOn/指明对应的请求。33.3所有返回报文包含Opcode/、<0pMsg>,OPaXk=O代表成功.其它为错误码,OPHSK为常识描述信.83. 3.4汉字编码字符应符合GBZT2312的要求.34接口会话要求3.1.1 调用接I前,应调用服务初始化接U建立会话并获得会话标识符凭此标识符进行后续的接口访问,在系列接口倜用结束后,应调用服务终止接11终止会话,并择放会话标识符.当会话空闹时间SZSD010005-2024超过平台设置的农夫空闲时间时,平台应主动终止限务,井自动修放会话标识符.3.1.2 调用颇率应不少于每经过一个站点传输1次.3.1.3 数据交换接口和交易接口可以直接调用,不需要建立和终止会话.4不同类型接口技术要求4.1服务初始化接口本接口用于建土用户与平台的会话,请求报文要求见表1.表1服务初始化清求报文元求名称炎燮描述取值说明Functionstring接门类量InitTinestaiipstringBt1.JK格式yyyyWIdHIh1.ss,在当前时间5«in内.必埴AiKhstring用户名用户身份标识,必加pxxvordstring加率变码E(时间SVM密码,左码小写,必mVersionstring版本号备用,必填C1.ientKeystring语求方K1.字证"用于接口加密坡密数据,可空C1.ientKexfSizeint请求方数字证书大小我队1024.可空响应报文要求见龙2,表2服务初始化的应报文元素名称类型描逑取的说明Functionstring接口类型InitOpCodcstring返回码。&示成功,其他则为Hf设码OpMsgstring错以描述任超文本RefCrenCeIdstring会话标识符当验证成功时返问,否则设置为空PubKeystring平台证书公交效撩平台设世PUbKeySizeint数字证书大小公交t累平台设置MrtiiVhxCcuntint7匚皎据返大记承效公交tk据平台设置IhtaNnxCountint数据校索返回最大记录数公交数据卞8设置Tineoutint会话有效时向公交数据平台设定.单位为分钟4-2数据交换接口4. 2.1数据库交换接口数据库交换接口功能要求如下:a)数据库交换请求消息文件可直接放到指定目录下由公交数据平台获取,或者通过API调用方式符请求消息直接发送到公交数据平台:b)数据库交换消息应包含一个发送方、一个数据源及数据食询条件、多个接收方及数据接收目的;C)消息按口应提供通用语言接口,满足不同系统的应用需求.4. 2.2文件交换接口2文件交换接口功能要求如下:a)文件交换请求消息文件可直接放到指定目录下由公交数据平价获取,或者通过API调用方式招请求消息H接发送到公交数据平台,消息接口应提供通用语言接口,满足不I可系统的应用需求:b)文件交换请求消息应描述多个被发送文件,包括文件名、文件目录和传输次序等信息:c)文件能够传输到多个接收方,在消息文件中描述多个接收方代码信息。43交易接口用户采用银联卡、实体卡、支付宝、德信、美团等方式支付乘车后,机具端生成乘车记录信息,铃由机具传抬给服务后台.机具服务后台通过此接口定义的数据规范将乘乍记录上送到公交数据平台.各类交易接口参数见表3。表3各类交易接口参数名林类型处否必须嫡述交易方式bizn0String是费务筑水9,由调用方提供,并保证唯一,不同的数据,该字段应保证不同支付宝、根联检、实体卡、ffi.美团merchant_idString是商户编号,由公交云负诋提供给接入方支付宝、艰联K、实体卡、徵信.美Ii1.off1inr_f1.agInteger否交易补上送标志,标志机具交易记录是实时上送还是补传上送,无诬记录内存,默认馔写1支付宝、微联卡、实体卡、tttfS.%If1.city_codeString是城市行政区划,以行政代码前6位支付宝.根联k、实体卡、&信、关闭pox_idString足POS终鼎g号支付宝、银联卡、实体卡、tftfS.美用bujs-idString«T4i支付宝、根联卡、实体卡、微信、关闭routc_idString是妙路编号支付宝、根联卡、实体卡、微信、美闭pospass.tine是交易实际发生时间.用户刷卡扫码时间(Unix时间戳,朱秒侑)支付宝、美团交用实际发生时间,用户刷卡扫码时问(Unix时间戳,0时区.杪值)银魏卡、实体卡、微信IngDoub1.ett刷卡发生地经度支付宝、极联卡、实体卡、微倍.美Ii1.IjKDoub1.ea刷卡发生地纬度支付宝、微联卡、实体卡、tttfS.%If1.annumInteger½交与实际拉效金颗(分为附位)支付宝、ttik.实体卡、&信、关闭ticketj>riceInteger是票价(分为单位)支付宝.极联卡、实体卡、tftfS.美用trndcn0Serins«PoS设省交易端水号支付宝、根联卡、实体卡、微信、关闭driveJidS1.rina否河机编号支付宝、制联卡、实体卡'徵信'荚团表3(续)名称类型是否。须摘注交切方式nttcndiinccti11c1.ongS司机打卡上班时何(UniX时回敬.生杪值)支付宝、美团司机打卡上班时间(Unix时间微.0时【又,花秒ff)SH联卡,实体卡、微1«c<xpany-nString否公司i号支付宝,实体卡、微M美团r«:civr_tinr1.ong½POSP接收POS报文时间(UniX时间Bi杪俶)支付宝PoSP接收PnS报文时间(Unix时间敏,。时区,条秒值)实体卜、微估、美团paytine1.ong是IPSP也到支付梁道完成支付记账的时间(UniX时间It>tf()支付宝PoSP收到支付渠道完成支付记IK的时间(Unix时间I1.0时区,老杪值)实体卡、微信、英团f1.eet.codeString否车队号支付叟.实体卡.我信、荚团user,idString用户唯标识,支付宝Uid支付宝11erchantorder.noString支付宝窗户仃里号,回户提交支付宝时的订尔号码,若机具后台负出与支付宝结算.此字段必填支付宝S做信商户订的号.商户提交微信时的订单号码.若机具后台领货与微伯结柒.此字段必填微伯美团商户订堆号,商户提交关团时的订单号训.若机共后台负货与荚团结好.此字段必填英团subjectString否支付宝育户订的主题,若机具后台(ft甜与支付宝结。.此字段必项支付宝交乙详情描述做信英团同户口班主题,若机具后台负出与关团结算.此字段必地荚团CHrdJypeString是支付宝电r公交卡类?»,如为乘车码时.埴。Antooooi支付宝card.csnString是1:物理号CSN(出厂时芯片的物理卡号,8字节IEX字符40,无法注取到物理卡号时,埴写全F实体代Chi1.d-Carc1.typeString是子K类型实体RChiId_urdJyPOString了卡类型实体卜bnInnerIntcgrr地卡内余额(分为单位)实体卡rnsuxc<n1.IntegerS卡带优次数实体卡open_idString是微,用户。Knid表3(续)名称类型处否必笈描述交治方式we<hai_ordernoString否微俏订。号,商户提交文村时获得的做IAiT的号,若机R后台负而与徵信结口,此字段必填於信ub1.icacc<ntidStringS微伯公众号IU微信IIgdjidString是用户唯一标识,美团Uid美团4,4公共参数要求公交数据平台公共参数见表4.表4公交数据平台公共参数名称类型是否必很描述nccca;s_idStringft应用ID(由公文云的接入机构分M的id).«|优环境使用tet1.d.对应密的为teshy.生产环境iff向对应实施的PW索ti11exta11pString是诂求时向格式yyyy一册ddHH:m:ax)methodString是接口方法名,详见a个接口定义的方法名versionString竹口