API数据服务接口开发指南Word下载.docx

1、52开发规2.1通信方式1）业务请HTTP协议请求，客户端以POST方式发送到服务平台。2）参数名称和参数说明中规定的固定值必须与列表中完全一致（大小写敏感）。3）目前接口支持签名方法：MD5的签名。2.2接口说明2.2.1返回参数通用返回数据格式：字段名类型是否必输responseCodeStringY请求操作相应码。操作成功返回0，操作失败响应码见通用响应码说明errorMessageN当responseCode不为0时，该参数不能为空，返回操作失败原因2.2.2通用返回码说明响应码成功（接收成功、执行成功）失败（接收失败、执行失败、拨打失败）错误：缺失必选参数：%s，请参考API文档参数

2、%s：%s存在非法字符，请参考API文档 例如：“参数VIN：123￥DFG9871SER23存在非法字符。”%s位数不正确，请参考API文档结束时间小于开始时间，请参考API文档6开始时间大于当前时间，请参考API文档7%s大于%s，请参考API文档 8%s不存在，请参考API文档9序号%s中缺失必选参数：10序号%s中参数%s：1112序号%s参数%s：1314%s格式错误，请参考API文档15预计总数：%s，实际总数%s，请检查16%s为空号17%s无人接听18%s:%s不存在1999超时3数据服务接口3.1importCustomerAndVHLData（FTP Monitor-TSS

3、）接口名称importCustomerAndVHLData调用方服务方接口描述监视器监控某个指定文件夹，如果有文件，则读取文件，并调用该接口，将客户数据和对应的车辆数据存储到TSS数据库中URL/tss/importData/V1/importCustomerAndVHLData接口类型RESTFul容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明total总数int客户和车辆配对总计customerVHLDataList客户、车辆、服务状态信息列表List数据类型参照4.1.1输出参数返回码参照返回值说明错误信息string当请求异常时，将返回error信

4、息返回值说明无count缺失countcustomerVHLList缺失customerVHLListNO缺失NO参数NO：%s存在非法字符，请参考API文档参数NO为全数字组成customerInfocustomerNamecustomerInfo中的所有必输项相同，都有缺失必选项参数错误序号%s中参数ownership：ownership围如下：1：个人；2：公司序号%s中参数IDType：IDType围如下：；组织机构代码证；3：护照；4：军官证VHLInfoVHLInfo中的所有必输项相同，都有缺失必选项参数错误序号%s中参数VIN：参数VIN值由字母和数字组成定义长度为17位序号%s

5、参数OEM：VHLInfo中Band、Series、Type、Color、dealerName与OEM相同，都有不存在错误序号%s中参数PurcaseDate：格式为YYYY/MM/DDserviceStatusisFreeServiceserviceStatus中的所有必输项相同，都有缺失必选项参数错误序号%s中参数isFreeService：参数isFreeService必须数字serviceStatus中所有int类型的数据都有此错误序号%s中参数remainingServiceDate：20total，实际总数：customerVHLDataList.size（），请检查例：1000，

6、实际总数：990，请检查213.2createLeads（TSS-TSM）createLeadsTSS将最新的客户静态信息、车辆静态信息和车辆服务状态信息导入到TSM，生成对应的Leads/tsm/createLeads/V1/createLeads需要生成Leads的总数生成Leads总数若为异常，则total为0leadsList对应的Leads信息leadsInfo数据类型参照4.1.5customercustomer中的所有必输项相同，都有缺失必选项参数错误3.3callTheCustomer（TSS-CCA）callTheCustomer将TSS中的客户传输到CCA，触发CCA拨打给

7、客户/cca/cti/V1/callTheCustomer车架号callNumber需要拨打的缺失VIN缺失callNumber参数callNumber：存在！#￥%&（）等非法字符3.4fishTheCall（CCA-TSS）fishTheCall销售与客户交流结束后，将通话开始时间、结束时间返回给TSS/tss/cti/V1/fishTheCallstartDate通话开始时间datetimeYYYY/MM/DD HH:mm:SSendDate通话开始结束时间缺失startDate缺失endDateVIN:参数startDate：参数endDate：3.5searchPastPackage

8、（TSS-ES）searchPastPackageTSS通过VIN查询外部系统，获取到该VIN对应的历史套餐列表/es/vehicle/V1/searchPastPackagepackageList套餐列表list参照4.1.6当responseCode为0时，packageList不为空packageList，请参考API文档3.6searchServiceStatus（TSS-ES）searchServiceStatusTSS通过VIN查询外部系统，获取到该VIN对应的当前服务状态信息/es/vehicle/V1/searchServiceStatus服务状态参照4.1.4当respons

9、eCode为0时，serviceStatus不为空serviceStatus，请参考API文档4附录4.1数据结构描述4.1.1customerVHLData列表名customerVHLData 客户对应车辆和服务状态信息集合No必选客户静态信息参照4.1.2车辆静态信息参照4.1.3车辆服务状态信息4.1.2customerInfocustomerInfo 客户静态信息customerID客户IDN/Y当在TSS中创建客户时为空，其他情况下，必须有唯一数值客户名称renewalTimes续约次数mobileNumber联系IDType证件类型IDNumber证件gender客户性别男；女ow

10、nership账号类型homeNumber家庭bacKUpNumber1备用1bacKUpNumber2备用2emailemergencyContact紧急联系人emergencyContactNumberwechat微信号companyName公司名称当账号类型为公司时，该字段为必输字段companyNumbercompanyAddress公司地址4.1.3VHLInfoVHLInfo 车辆静态信息OEM厂商Band品牌Series车系Type车型Color颜色dealerName经销商名称dealerPhoneNumber经销商dealerAddress经销商地址License车牌号MDN

11、车载PurcaseDate购买时间YYYY/MM/DD4.1.4serviceStatusserviceStatus 车辆服务状态信息是否处于免费服务期在；不在remainingServiceDate服务到期时间activeProduct当前套餐名称dataUsed当月花费流量单位:GBminutesUsed当月花费分钟数单位：分钟POISearchPOI搜索次数remoteLock_unlock远程解闭锁次数autoAlert自动报警次数roadsideAssistance道路救援次数emergencyAssistance紧急救援次数ACRAssistance碰撞自动救援次数destinationDownloads目的地下载次数parkingIndication停车位置提示次数remoteHorni