API数据服务接口开发指南Word下载.docx
《API数据服务接口开发指南Word下载.docx》由会员分享，可在线阅读，更多相关《API数据服务接口开发指南Word下载.docx（23页珍藏版）》请在冰豆网上搜索。
5
2开发规
2.1通信方式
1）业务请HTTP协议请求，客户端以POST方式发送到服务平台。
2）参数名称和参数说明中规定的固定值必须与列表中完全一致（大小写敏感）。
3）目前接口支持签名方法：
MD5的签名。
2.2接口说明
2.2.1返回参数
通用返回数据格式：
字段名
类型
是否必输
responseCode
String
Y
请求操作相应码。
操作成功返回0，操作失败响应码见通用响应码说明
errorMessage
N
当responseCode不为0时，该参数不能为空，返回操作失败原因
2.2.2通用返回码说明
响应码
成功（接收成功、执行成功）
失败（接收失败、执行失败、拨打失败）
错误：
缺失必选参数：
%s，请参考API文档
参数%s：
%s存在非法字符，请参考API文档例如：
“参数VIN：
123￥DFG9871SER~23存在非法字符。
”
%s位数不正确，请参考API文档
结束时间小于开始时间，请参考API文档
6
开始时间大于当前时间，请参考API文档
7
%s大于%s，请参考API文档
8
%s不存在，请参考API文档
9
序号%s中缺失必选参数：
10
序号%s中参数%s：
11
12
序号%s参数%s：
13
14
%s格式错误，请参考API文档
15
预计总数：
%s，实际总数%s，请检查
16
%s为空号
17
%s无人接听
18
%s:
%s不存在
19
99
超时
3数据服务接口
3.1importCustomerAndVHLData（FTPMonitor-TSS）
接口名称
importCustomerAndVHLData
调用方
服务方
接口描述
监视器监控某个指定文件夹，如果有文件，则读取文件，并调用该接口，将客户数据和对应的车辆数据存储到TSS数据库中
URL
/tss/importData/V1/importCustomerAndVHLData
接口类型
RESTFul
容格式
JSON
版本号
V1
请求方法
POST
输入参数
参数代码
参数名称
数据类型
必输
参数说明
total
总数
int
客户和车辆配对总计
customerVHLDataList
客户、车辆、服务状态信息列表
List<
customerVHLData>
数据类型参照4.1.1
输出参数
返回码
参照返回值说明
错误信息
string
当请求异常时，将返回error信息
返回值说明
无
count
缺失count
customerVHLList
缺失customerVHLList
NO
缺失NO
参数NO：
%s存在非法字符，请参考API文档
参数NO为全数字组成
customerInfo
customerName
customerInfo中的所有必输项相同，都有缺失必选项参数错误
序号%s中参数ownership：
ownership围如下：
1：
个人；
2：
公司
序号%s中参数IDType：
IDType围如下：
；
组织机构代码证；
3：
护照；
4：
军官证
VHLInfo
VHLInfo中的所有必输项相同，都有缺失必选项参数错误
序号%s中参数VIN：
参数VIN值由字母和数字组成
定义长度为17位
序号%s参数OEM：
VHLInfo中Band、Series、Type、Color、dealerName与OEM相同，都有不存在错误
序号%s中参数PurcaseDate：
格式为YYYY/MM/DD
serviceStatus
isFreeService
serviceStatus中的所有必输项相同，都有缺失必选项参数错误
序号%s中参数isFreeService：
参数isFreeService必须数字
serviceStatus中所有int类型的数据都有此错误
序号%s中参数remainingServiceDate：
20
[total]，实际总数：
[customerVHLDataList.size（）]，请检查
例：
1000，实际总数：
990，请检查
21
3.2createLeads（TSS-TSM）
createLeads
TSS将最新的客户静态信息、车辆静态信息和车辆服务状态信息导入到TSM，生成对应的Leads
/tsm/createLeads/V1/createLeads
需要生成Leads的总数
生成Leads总数
若为异常，则total为0
leadsList
对应的Leads信息
leadsInfo>
数据类型参照4.1.5
customer
customer中的所有必输项相同，都有缺失必选项参数错误
3.3callTheCustomer（TSS-CCA）
callTheCustomer
将TSS中的客户传输到CCA，触发CCA拨打给客户
/cca/cti/V1/callTheCustomer
车架号
callNumber
需要拨打的
缺失VIN
缺失callNumber
参数callNumber：
存在～！
#￥%&
×
（）等非法字符
3.4fishTheCall（CCA-TSS）
fishTheCall
销售与客户交流结束后，将通话开始时间、结束时间返回给TSS
/tss/cti/V1/fishTheCall
startDate
通话开始时间
datetime
YYYY/MM/DDHH:
mm:
SS
endDate
通话开始结束时间
缺失startDate
缺失endDate
VIN:
参数startDate：
参数endDate：
3.5searchPastPackage（TSS-ES）
searchPastPackage
TSS通过VIN查询外部系统，获取到该VIN对应的历史套餐列表
/es/vehicle/V1/searchPastPackage
packageList
套餐列表
list<
package>
参照4.1.6
当responseCode为0时，packageList不为空
packageList，请参考API文档
3.6searchServiceStatus（TSS-ES）
searchServiceStatus
TSS通过VIN查询外部系统，获取到该VIN对应的当前服务状态信息
/es/vehicle/V1/searchServiceStatus
服务状态
参照4.1.4
当responseCode为0时，serviceStatus不为空
serviceStatus，请参考API文档
4附录
4.1数据结构描述
4.1.1customerVHLData
列表名
customerVHLData客户对应车辆和服务状态信息集合
No
必选
客户静态信息
参照4.1.2
车辆静态信息
参照4.1.3
车辆服务状态信息
4.1.2customerInfo
customerInfo客户静态信息
customerID
客户ID
N/Y
当在TSS中创建客户时为空，其他情况下，必须有唯一数值
客户名称
renewalTimes
续约次数
mobileNumber
联系
IDType
证件类型
IDNumber
证件
gender
客户性别
男；
女
ownership
账号类型
homeNumber
家庭
bacKUpNumber1
备用1
bacKUpNumber2
备用2
email
emergencyContact
紧急联系人
emergencyContactNumber
wechat
微信号
companyName
公司名称
当账号类型为公司时，该字段为必输字段
companyNumber
companyAddress
公司地址
4.1.3VHLInfo
VHLInfo车辆静态信息
OEM
厂商
Band
品牌
Series
车系
Type
车型
Color
颜色
dealerName
经销商名称
dealerPhoneNumber
经销商
dealerAddress
经销商地址
License
车牌号
MDN
车载
PurcaseDate
购买时间
YYYY/MM/DD
4.1.4serviceStatus
serviceStatus车辆服务状态信息
是否处于免费服务期
在；
不在
remainingServiceDate
服务到期时间
activeProduct
当前套餐名称
dataUsed
当月花费流量
单位:
GB
minutesUsed
当月花费分钟数
单位：
分钟
POISearch
POI搜索次数
remoteLock_unlock
远程解闭锁次数
autoAlert
自动报警次数
roadsideAssistance
道路救援次数
emergencyAssistance
紧急救援次数
ACRAssistance
碰撞自动救援次数
destinationDownloads
目的地下载次数
parkingIndication
停车位置提示次数
remoteHorni
升级会员 