api数据服务接口开发指南.docxVIP

Target-S 外部接口说明书 PAGE 15四键信息 PAGE 1四键信息 Target-S 外部接口说明书 上海四键信息技术 Fourth Button, Inc. 日期: 2016-05-19 变更记录 序号 说明 变更人 时间  目录 TOC \o 1-3 \h \z \u 1 引言 1 1.1 概述 1 1.2 名词缩写及定义 1 1.3 历史变更 1 2 开发规范 2 2.1 通信方式 2 2.2 接口说明 2 2.2.1 返回参数 2 2.2.2 通用返回码说明 2 3 数据服务接口 4 3.1 importCustomerAndVHLData（FTP Monitor-TSS） 4 3.2 createLeads（TSS-TSM） 5 3.3 leads 需要外部文件导入的，是修改leads状态码？ 7 3.4 callTheCustomer(TSS-CCA) 8 3.5 fishTheCall（CCA-TSS） 9 4 附录 11 4.1 数据结构描述 11 4.1.1 customerVHLData 11 4.1.2 customerInfo 11 4.1.3 VHLInfo 12 4.1.4 serviceStatus 13 4.1.5 leadsInfo 13 4.2 HTTP返回值处理策略 14 引言 概述 略 名词缩写及定义 名词缩写 定义 VIN 17位国际VIN码规则 TSS Target-S System TSM Target-S Model CCA 外部系统，用于拨打电话给客户的系统 FTP Monitor 文件监视器，用于监测文件夹中是否存在文件，如果存在文件，则读取文件内容并通知TSS做相应处理 ES External System 外部系统 历史变更 序号 说明 变更人 时间 1 2 3 4 5  开发规范 通信方式 业务请求是HTTP协议请求，客户端以POST方式发送到服务平台。 参数名称和参数说明中规定的固定值必须与列表中完全一致（大小写敏感）。 目前接口支持签名方法：MD5的签名。 接口说明 返回参数 通用返回数据格式： 字段名 类型 是否必输 说明 responseCode String Y 请求操作相应码。操作成功返回0，操作失败响应码见通用响应码说明 errorMessage String N 当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（FTP Monitor-TSS） 接口名称 importCustomerAndVHLData 调用方 FTP Monitor 服务方 TSS 接口描述 监视器监控某个指定文件夹，如果有文件，则读取文件，并调用该接口，将客户数据和对应的车辆数据存储到TSS数据库中 URL /tss/importData/V1/importCustomerAndVHLData 接口类型 RESTFul 内容格式 JSON 版本号 V1 请求方法 POST 输入参数 参数代码 参数名