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

13/15Target-S外部接口说明书四键信息技术FourthButton,Inc.日期:2016-05-19变更记录序号说明变更人时间目录1引言11.1概述11.2名词缩写与定义11.3历史变更12开发规22.1通信方式22.2接口说明22.2.1返回参数22.2.2通用返回码说明23数据服务接口43.1importCustomerAndVHLData〔FTPMonitor-TSS〕43.2createLeads〔TSS-TSM〕53.3leads需要外部文件导入的，是修改leads状态码？73.4callTheCustomer(TSS-CCA)83.5fishTheCall〔CCA-TSS〕94附录114.1数据结构描述114.1.1customerVHLData114.1.2customerInfo114.1.3VHLInfo124.1.4serviceStatus134.1.5leadsInfo134.2HTTP返回值处理策略14引言概述略名词缩写与定义名词缩写定义VIN17位国际VIN码规那么TSSTarget-SSystemTSMTarget-SModelCCA外部系统，用于拨打给客户的系统FTPMonitor文件监视器，用于监测文件夹中是否存在文件，如果存在文件，那么读取文件容并通知TSS做相应处理ESExternalSystem外部系统历史变更序号说明变更人时间12345开发规通信方式业务请HTTP协议请求，客户端以POST方式发送到服务平台。参数名称和参数说明中规定的固定值必须与列表中完全一致〔大小写敏感〕。目前接口支持签名方法：MD5的签名。接口说明返回参数通用返回数据格式：字段名类型是否必输说明responseCodeStringY请求操作相应码。操作成功返回0，操作失败响应码见通用响应码说明errorMessageStringN当responseCode不为0时，该参数不能为空，返回操作失败原因通用返回码说明响应码说明0成功〔接收成功、执行成功〕1失败〔接收失败、执行失败、拨打失败〕2错误：缺失必选参数：%s，请参考API文档3错误：参数%s：%s存在非法字符，请参考API文档例如：“参数VIN：123￥DFG9871SER~23存在非法字符。〞4错误：参数%s：%s位数不正确，请参考API文档5错误：完毕时间小于开始时间，请参考API文档6错误：开始时间大于当前时间，请参考API文档7错误：参数%s：%s大于%s，请参考API文档8错误：参数%s：%s不存在，请参考API文档9错误：序号%s中缺失必选参数：%s，请参考API文档10错误：序号%s中参数%s：%s存在非法字符，请参考API文档例如：“参数VIN：123￥DFG9871SER~23存在非法字符。〞11错误：序号%s中参数%s：%s位数不正确，请参考API文档12错误：序号%s参数%s：%s大于%s，请参考API文档13错误：序号%s参数%s：%s不存在，请参考API文档14错误：序号%s中参数%s：%s格式错误，请参考API文档15错误：预计总数：%s，实际总数%s，请检查16错误：%s为空号17错误：%s无人接听18错误：%s:%s不存在19错误：参数%s：%s格式错误，请参考API文档99超时数据服务接口importCustomerAndVHLData〔FTPMonitor-TSS〕接口名称importCustomerAndVHLData调用方FTPMonitor服务方TSS接口描述监视器监控某个指定文件夹，如果有文件，那么读取文件，并调用该接口，将客户数据和对应的车辆数据存储到TSS数据库中URL/tss/importData/V1/importCustomerAndVHLData接口类型RESTFul容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明total总数intY客户和车辆配对总计customerVHLDataList客户、车辆、服务状态信息列表List<customerVHLData>Y数据类型参照4.1.1输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时，将返回error信息返回值说明序号responseCodeerrorMessage说明10无22错误：缺失必选参数：count缺失count32错误：缺失必选参数：customerVHLList缺失customerVHLList42错误：缺失必选参数：NO缺失NO53错误：参数NO：%s存在非法字符，请参考API文档参数NO为全数字组成69错误：序号%s中缺失必选参数：customerInfo79错误：序号%s中缺失必选参数：c