1 / 114
文档名称:

互联网道路客运业务平台对接数据接口开发指南.docx

格式:docx   大小:333KB   页数:114页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

互联网道路客运业务平台对接数据接口开发指南.docx

上传人:资料之王 2021/5/25 文件大小:333 KB

下载得到文件列表

互联网道路客运业务平台对接数据接口开发指南.docx

文档介绍

文档介绍:附件1:
互联网道路客运业务平台对接
数据接口开发指南
2021年5月
概述
文档内容
本文档主要就省系统与互联网道路客运业务的互联网平台系统对接的接口方式、数据格式、传送方式等内容进行具体的描述。内容包括:系统结构、数据定义、接口实现方法的说明,并说明身份认证、查询和上报数据的报文内容。
阅读对象
本文档适用于接口调用方的技术经理、工程师及测试工程师阅读。
系统结构
系统结构示意图如图2-1所示。
图2-1 系统结构示意图
说明:
(1)接口调用方通过互联网访问服务接口。
(2)数据接口共三个,分别为:身份认证接口、数据上报接口和数据查询接口。身份认证接口是指调用其他接口前需要先进行访问的身份认证,成功通过身份认证后,才能访问相关接口,身份信息由接口平台统一发放;数据上报接口是指调用方根据业务需要及接口规范调用接口查询数据。
接口协议
接口方式
本规范采用Web API的方式处理请求。请求需要通过身份验证机制。
实现机制
由调用方根据规范的要求服务接口提交有关数据,调用方根据实际业务的要求返回相应的结果,如图3-1所示。
图3-1 接口使用模式
通用身份验证
通过接口发放的用户名、密码,对访问服务网关前进行身份认证,认证成功将返回有效令牌,令牌有效期为2小时。
数据定义
数据文件定义
数据体文件为JSON格式文件,编码方式为UTF-8。
数据格式
本文档中提及的数据格式为查询、上报数据内容的格式,作为Web Api的传入参数。字符串传入参数消息与输出消息由消息头和消息基本信息、消息详细内容组成消息体。如下图所示:
通用对外服务接口统一使用 UTF-8 编码的 JSON 编码,接口通信协议以HTTP POST协议为主。
要求http请求的header进行如下设置:
Accept-Charset: utf-8
Content-type: application/x-www-form-urlencoded
要求请求用POST方法,json采用UTF-8编码。(此处需要保留charset=utf-8)
访问不进来报415等错误,一般是因为设置了头Accept:application/json Content-type: application/json。
通用数据接口
功能描述
用于基础数据模型的上报和查询处理操作方法。
以 http 请求接口,地址为:http://ip:port/api/ServiceGateway/DataService
(具体地址请询问联调工作人员,或见附录)
认证Token
需要认证的接口必须在请求头部添加key为Token的键值对

请求报文
1、请求报文主结构体
序号
标签
约束
类型
说明
1
publicrequest
必填
string
公共请求,JSON格式
2
body
必填
string
业务查询参数内容,JSON格式

2、公共请求报文结构
序号
标签
约束
类型
长度
说明
1
sysid
必填
string
36
系统ID,固定取:
11922B15-5816-4A50-B98C-4C258BF81129
2
reqid
必填
string
36
请求事务编号,在发起方生成36位字符串的唯一标示,例如:
C11B6094-D33C-42C3-85D5-C9A7F6159FDB
3
protover
必填
string
4
通信协议版本号,例如:
4
servicever
必填
string
4
服务接口版本号,例如:
5
servicecode
必填
string
10
业务服务编号,业务自定义
6
requesttime
必填
string
请求时间,格式:YYYYMMDDhhmmss
例如:20180305164711562
7
signdata
string
签名数据:对body内容进行签名
8
reserve
string
64
用于通信协议扩充使用
3、body内部数据结构由业务自行定义
响应报文
1、响应报文主结构体
序号
标签
约束
类型
说明
1
publicresponse
必填
string
公共响应,JSON格式
2
body
必填
string
返回内容,J