Yb-QaAutomationHub/resources/integration/showdoc文档.md at 2bc036c86781f744692b212ed28ecd418f630304

xst/Yb-QaAutomationHub

Fork 0

Files

T

xst 2bc036c867 feat: 安徽运八需求全流水线输出同步 + 知识库/agents/资源文件更新

2026-07-14 15:50:17 +08:00

70 KiB

Raw Blame History

token生成规则Demo.zip

说明

[TOC]

简要描述

所有数据上传接口采用统一请求参数格式，方便鉴权。partnerId、appId、workerId以及密钥值由我司分配，具体的数据放在args参数中传递。

请求URL

http://xxx.com/api/xxx/xxx

请求方式

POST

请求头

token。 token值生成规则：请求体的json字符串值+密钥，以MD5算法加密。

请求参数

参数名	必选	类型	说明
partnerId	是	String	合作商ID
appId	是	String	应用ID
workerId	是	String	人员ID
args	是	Map<String, Object>	请求参数

请求示例

{
   "partnerId": "xxx",
   "appId": "xxx",
   "workerId": "001",
   "args": {
        "xxx1":"aaa",
        "xxx2":["bbb","ccc"]
    }
}

返回参数说明

参数	名称	类型	说明
success	成功标志	boolean	返回true或false
message	返回信息	String	返回的提示信息
code	返回代码	int	如200：成功，500：服务器内部错误等
result	返回数据	Object	如有需要，返回数据对象
timestamp	时间戳	long	13位时间戳，精确到毫秒

返回示例

 {
    "success": false,
    "message": "操作失败",
    "code": 500,
    "result": null,
    "timestamp": 1672107371245
}

fea.xlsx

《监管平台代码集》

#代码集相关代码字段：

业务类型代码（BusinessTypeCode）车牌颜色代码（VehiclePlateColorCode）营运车辆类型代码（VehicleType）车辆能源类型代码（VehicleEnergyType）货物分类代码（CargoTypeClassification）付款方式代码（PaymentMeansCode）银行代码（BankCode）运输组织类型代码（TransportTypeCode）保险机构代码（InsuranceInformation）国别代码（CountrySubdivisionCode）国家行政区划代码（CountrySubdivisionCod）省份区划代码（ProvinceCode）从业人员资格代码（WorkTypeCode）道路运输证经营范围（BusinessScopeCode）性别（Gender）证照状态（CertificateState）业户经营状态（OperatingStatus）校验项内容（VerifyCode）运输组货方式代码车牌类型代码（LicensePlateTypeCode）

[TOC]

上传委托合同（框架）

简要描述

上传委托合同（框架），委托合同（框架）和委托合同二选一进行上报；文件信息可以暂时不传，在修改委托合同的时候再补充合同文件。

请求URL

xxxxxx/api/dataUpload/mandateContractFrame

请求方式

POST

args请求参数

参数名	必选	类型	说明
unified_social_credit_identifier	可选	String	货主企业统一社会信用代码，要么单托运企业，要么一个框架合同对应多家托运企业，如果都传值，默认取单托运企业
owner_enterprise_name	可选	String	货主企业名称
enterpriseList	可选	List	货主企业列表，要么单托运企业，要么一个框架合同对应多家托运企业，如果都传值，默认取单托运企业
contract_number	是	String	合同编号
expire_time	是	String	合同有效期截止时间 yyyy-MM-dd
uploadFileInfo	否	List	文件信息

enterpriseList子项参数

参数名	必选	类型	说明
unified_social_credit_identifier	是	String	货主企业统一社会信用代码
owner_enterprise_name	是	String	货主企业名称

uploadFileInfo子项参数

参数名	必选	类型	说明
name	可选	String	文件名称和合同文件路径需一起上传/不上传，文件名称需要带后缀，和合同的url后面文件的后缀保持一致
url	可选	String	合同文件url,和dataList二选一填写
dataList	可选	String	base64, 和url二选一填写

请求示例

{
    "workerId": "001",
    "appId": "default",
    "partnerId": "test",
    "args": {
        "unified_social_credit_identifier": "123456",
        "owner_enterprise_name": "szjttest",
        "enterpriseList": [
            {
                "unified_social_credit_identifier": "111111",
                "owner_enterprise_name": "关联企业一"
            },
            {
               "unified_social_credit_identifier": "222222",
                "owner_enterprise_name": "关联企业二"
            }
        ],
        "contract_number": "666666",
        "expire_time": "2022-12-14",
        "uploadFileInfo": [
            {
                "name": "合肥税务监管平台V1.0  结项表.pdf",
                "url": "https://file.rlsk.link/file/合肥税务监管平台V1.0  结项表_1653982927764.pdf",
                "dataList": ""
            },
            {
                "name": "合肥税务监管平台V1.0  结项表.pdf",
                "url": "https://file.rlsk.link/file/合肥税务监管平台V1.0  结项表_1653982927764.pdf",
                "dataList": ""
            }
        ]
    }
}

返回参数说明

参数	名称	类型	说明
success	成功标志	boolean	返回true或false
message	返回信息	String	返回的提示信息
code	返回代码	int	如200：成功，500：服务器内部错误等
result	返回数据	Object	如有需要，返回数据对象
timestamp	时间戳	long	13位时间戳，精确到毫秒

返回示例

{
    "success": true,
    "message": "",
    "code": 200,
    "result": true,
    "timestamp": 1672121404682
}

[TOC]

一、第一次上传

简要描述

第一次上传完后，会进行实时单核验

请求URL

xxxxxx/api/dataUpload/firstUpload

请求方式

POST

请求参数

参数名	必选	类型	说明
waybillInfo	是	Obejct	建单信息
consignorInfo	是	Object	托运人信息
consigneeInfo	是	Object	收货方信息
driverInfo	是	Object	司机信息
carInfo	是	Object	接单车辆信息
insuranceInformation	否	Object	保险信息
goodsInfos	是	List	货物信息

waybillInfo子项参数

参数名	必选	类型	说明
originalDocumentNumber	是	String	上游企业委托运输单号(最大长度35位)
shippingNoteNumber	是	String	本运单单号(最大长度20位)
documentCreateTime	是	String	托运人建单时间(14位)。yyyyMMddHHmmss（example:20220530143259）
carrier	是	String	网络货运经营者名称
unifiedSocialCreditIdentifier	是	String	网络货运经营者统一社会信用代码(最大长度18位)
permitNumber	是	String	网络货运经营者的道路运输经营许可证编号，最大长度50位，网络货运经营者整合车辆全部为总质量4.5吨及以下普通货运车辆的，可填“企业所在地行政区划代码+000000”
businessTypeCode	是	String	详见代码集《业务类型代码》
goodsArrangementTypeCode	是	String	详见代码集《运输组货方式代码》
orderReceivingTime	是	String	司机接单的时间(14位)。yyyyMMddHHmmss（example:20220530143259）
departureTime	是	String	司机起运的时间(14位)。yyyyMMddHHmmss（example:20220530143259)
commercialContractNumber	是	String	承运合同编号,平台与司机签订的合同编号
contractNumber	可选	String	委托合同编号,托运人与平台签订的合同编号
mileage	可选	String	运输里程，可保留3位小数

consignorInfo子项参数

参数名	必选	类型	说明
consignor	是	String	托运人名称，需和货主框架合同信息保持一致
consignorId	是	String	托运人统一社会信用代码，需和货主框架合同信息保持一致
frameContractNumber	可选	String	需和委托合同（框架）信息保持一致,最大长度30位，委托合同（框架）和委托合同二选一上报
placeOfLoading	是	String	实际装货的地点格式为省/市/县(区)/详细地址
loadingLongitude	是	String	实际装货的地点经度，最长保留6位小数
loadingLatitude	是	String	实际装货的地点纬度，最长保留6位小数
loadingCountrySubdivisionCode	是	String	参照最新版《中华人民共和国行政区划代码》（GB/T 2260-2017），精确到区县。详见代码集《国家行政区划代码》

consigneeInfo子项参数

参数名	必选	类型	说明
consignee	是	String	收货方名称
consigneeId	是	String	收货方统一社会信用代码，若收款方为个人，则为身份证号
goodsReceiptPlace	是	String	实际收货的地点格式为省/市/县(区)/详细地址
unLoadingLongitude	是	String	实际收货的地点经度，最长保留6位小数
unLoadingLatitude	是	String	实际收货的地点纬度，最长保留6位小数
unLoadingNationSubdivisionCode	是	String	参照最新版《中华人民共和国行政区划代码》（GB/T 2260-2017），精确到区县。详见代码集《国家行政区划代码》

driverInfo子项参数

参数	名称	必选	类型	说明
driverName	姓名	是	String	根据机动车驾驶证填写
telephone	手机号码	是	String
drivingIdNumber	身份证号	是	String	身份证号
drivingLicense	驾驶证编号	是	String	根据机动车驾驶证填写
vehicleClass	准驾车型	是	String	根据机动车驾驶证填写
issuingOrganizations	驾驶证发证机关	是	String	根据机动车驾驶证填写
validPeriodFrom	驾驶证有效期自	是	String	根据机动车驾驶证填写。yyyyMMdd
validPeriodTo	驾驶证有效期至	是	String	根据机动车驾驶证填写。yyyyMMdd
qualificationCertificate	从业资格证号	是	String	驾驶员身份证号可代替进行上传，最大长度19位字符，使用总质量4.5吨及以下普通货运车辆从事普通货物运输经营的驾驶员，填写“驾驶员身份证前6位+000000”
provinceCode	从业资格的国家行政区划代码	是	String	“详见代码集《国家行政区划代码》从业资格证上的省份填写相应代码”
qualificationCertificateFrom	从业资格证有效期自	否	String	从业资格证有效期自，根据从业资格证填写，yyyyMMdd。为空时需要传null
qualificationCertificateTo	从业资格证有效期至	否	String	从业资格证有效期至，根据从业资格证填写，yyyyMMdd。为空时需要传null
taxRegistrationCertificate	司机税务登记证号	可选	String
registerDate	驾驶员注册日期	是	String	驾驶员在网络货运企业注册成为会员的日期。yyyyMMdd
anchoredUrl	司机挂靠协议	否	List

carInfo子项参数

参数	名称	必选	类型	说明
vehicleNumber	车辆牌照号	是	String
vehiclePlateColorCode	车牌颜色代码	是	String	详见代码集《车牌颜色代码》
vehicleType	车辆类型代码	是	String	详见代码集《车辆类型代码》
LicensePlateTypeCode	车牌类型代码(注意首字母大写)	是	String	详见代码集《车牌类型代码》
owner	所有人	是	String	按照机动车行驶证填写
ownerId	所有人统一社会信用代码或个人证件号	可选	String
useCharacter	使用性质	是	String	按照机动车行驶证填写
vin	车辆识别代号	是	String	按照机动车行驶证填写
issuingOrganizations	发证机关	是	String	按照机动车行驶证填写
registerDate	注册日期	是	String	按照机动车行驶证填写。yyyyMMdd
issueDate	发证日期	是	String	按照机动车行驶证填写。yyyyMMdd
vehicleEnergyType	车辆能源类型	是	String	详见代码集《车辆能源类型》
vehicleTonnage	核定载质量	是	Double	参考机动车行驶证填写，默认单位：吨，保留两位小数，如整数的话，以.00填充
grossMass	总质量	是	Double	参考机动车行驶证填写，默认单位：吨，保留两位小数，如整数的话，以.00填充
roadTransportCertificateNumber	道路运输证号	是	String	可用0进行填充，最大长度20位字符(字母数字混填)，总质量4.5吨及以下普通货运车辆的，可填“车籍地6位行政区域代码+000000”
trailerVehiclePlateNumber	挂车牌照号	否	String
vehicleLicenseNumber	行驶证档案编号	否	String	可用0进行填充，长度为12-18位字符
roadTransportSocialCreditFrom	道路运输证有效期自	否	String	道路运输证有效期自，按照道路运输证填写。yyyyMMdd
roadTransportSocialCreditTo	道路运输证有效期至	否	String	道路运输证有效期至，按照道路运输证填写。yyyyMMdd
anchoredUrl	车辆挂靠协议	否	List

goodsInfos子项参数

参数名	必选	类型	说明
descriptionOfGoods	是	String	货物名称，如一车货有不同货物，则可循环
cargoTypeClassificationCode	是	String	详见代码集《货物类型代码》
quantity	是	Double	货物量，重量/体积/件数/车数等，数值,计量单位用从unit字段传入
unit	是	String	计量单位,格式为:吨/件/车/立方米等

insuranceInformation子项参数

参数名	必选	类型	说明
policyNumber	是	String	保险单号，未投保的，可填none，最大长度50位字符
insuranceCompany	是	String	保险公司名称，详见代码集《保险机构代码》。未投保的，可填“无”

contractUrl子项参数

参数	名称	必选	类型	说明
name	委托合同文件名称	否	String	需要加文件格式后缀名png/jpg/jpeg/pdf，例如：合同文件.png
url	委托合同文件地址	可选	String	url和dataList任选一项必填
dataList	委托合同文件对象	可选	String	base64, url和dataList任选一项必填

请求示例

{
   "partnerId": "xxx",
   "appId": "xxx",
   "workerId": "001",
   "args": {
        "waybillInfo":{
            "businessTypeCode":"1002996",
            "carrier":"网络货运企业名称",
            "documentCreateTime":"20460228000000",
            "goodsArrangementTypeCode":"011",
            "originalDocumentNumber":"ys2222",
            "permitNumber":"123456789012",
            "shippingNoteNumber":"test008",
            "departureTime": "20900203010233",
            "orderReceivingTime":"20220530143259",
             "contractNumber":"cb123456789",
             "commercialContractNumber":"ss123456789",
            "unifiedSocialCreditIdentifier":"1111",
			"mileage": "200.234"
        },
		 "insuranceInformation":{
            "insuranceCompany":"ABIC",
            "policyNumber":"123456"
        },
        "consignorInfo":{
            "consignor":"托运人的名字",
            "consignorId":"422801199903260045",
            "frameContractNumber":"",
            "loadingCountrySubdivisionCode":"370211",
            "placeOfLoading":"山东省/青岛市/黄岛区",
            "loadingLongitude":"107.298671",
            "loadingLatitude":"40.796694"
        },
        "consigneeInfo":{
            "consignee":"我是收货方名称",
            "consigneeId":"422801199903260088",
            "goodsReceiptPlace":"河北省/邯郸市/永年区",
            "unLoadingLongitude":"107.298671",
            "unLoadingLatitude":"40.796694",
            "unLoadingNationSubdivisionCode":"370200"
        },
		"carInfo":{
            "grossMass":33,
            "issueDate":"20211212",
            "issuingOrganizations":"我的发证机关",
            "LicensePlateTypeCode":"01",
            "owner":"刘司机的车",
            "ownerId":"123456789",
            "registerDate":"20231212",
            "roadTransportCertificateNumber":"123456789012",
            "roadTransportSocialCreditFrom":"20211213",
            "roadTransportSocialCreditTo":"20221212",
            "trailerVehiclePlateNumber":"鄂A12345",
            "useCharacter":"商用",
            "vehicleEnergyType":"A",
            "vehicleLicenseNumber":"111111111111111111",
            "vehicleNumber":"赣GP3217",
            "vehiclePlateColorCode":"2",
            "vehicleTonnage":33,
            "vehicleType":"H10",
            "vin":"12423515",
            "anchoredUrl":[
                {
                    "name":"车辆挂靠协议.pdf",
                    "url":"https://www.123.com",
                    "dataList":"文件"
                }
            ]
        },
		"driverInfo":{
            "driverName":"测试司机",
            "drivingIdNumber":"110101199003074530",
            "drivingLicense":"12111561651561",
            "issuingOrganizations":"我就是驾驶证发证机关",
            "qualificationCertificate":"111",
            "qualificationCertificateFrom":"20241212",
            "qualificationCertificateTo":"20251212",
            "taxRegistrationCertificate":"123455",
            "telephone":"18871999035",
            "validPeriodFrom":"20261212",
            "validPeriodTo":"20271212",
            "vehicleClass":"准驾车型",
            "provinceCode":"123456",
            "anchoredUrl":[
                {
                    "name":"司机挂靠协议.pdf",
                    "url":"https://www.123.com",
                    "dataList":"文件"
                }
            ]
        },
        "goodsInfos":[
            {
                "cargoTypeClassificationCode":"100",
                "descriptionOfGoods":"手机",
                "quantity":"100",
                "unit":"吨"
            },
            {
                "cargoTypeClassificationCode":"100",
                "descriptionOfGoods":"手机",
                "quantity":"100",
                "unit":"吨"
            }
        ]
    }
}

返回参数说明

参数	名称	类型	说明
success	成功标志	boolean	返回true或false
message	返回信息	String	返回的提示信息
code	返回代码	int	如200：成功，500：服务器内部错误等
result	返回数据	Object	如有需要，返回数据对象
timestamp	时间戳	long	13位时间戳，精确到毫秒

返回示例

{
    "success": true,
    "message": "",
    "code": 200,
    "result": true,
    "timestamp": 1672121404682
}

二、第二次上传

[TOC]

简要描述

第二次上传完后，会进行运单重复、车辆资质、司机资质、集中支付、资金流水、合同、车辆轨迹核验

请求URL

xxxxxx/api/dataUpload/secondUpload

请求方式

POST

args请求参数

参数	名称	必选	类型	说明
arrivalInfo	运抵信息	是	Object
ownerStatements	货主流水	是	List
carrierStatements	承运人流水	是	List
carrierContractInfo	承运合同（承运人）	是	Object	承运合同（承运人）
ownerContractInfo	委托合同（货主）	可选	Object	委托合同（框架）和委托合同二选一上报
trackList	车辆轨迹	是	List

arrivalInfo子项参数

参数	名称	必选	类型	说明
shippingNoteNumber	托运单号	是	String	本运单单号(最大长度20位)
startTicketFileUrl	起运磅票文件（发货单）	是	List	支持上传多个文件
arrivalTime	运抵时间	是	String	司机运抵的时间。yyyyMMddHHmmss
arrivalTicketFileUrl	运抵磅票文件（收货单）	是	List	支持上传多个文件
waybillFreightAmount	承运运费金额（不含运费差价）	是	Double	此运单网络货运经营者实际支付承运人的运费金额，即网络货运经营者与承运人签订的该运单的司机运单合同付款金额，货币单位为人民币（元），保留3位小数，如整数的话，以.000填充。
totalMonetaryAmount	委托运费金额（含运费差价）	是	Double	此运单托运人实际支付网络货运经营者的运费金额，即托运人与网络货运经营者签订的该运单的货主运单合同付款金额，货币单位为人民币（元），保留3位小数，如整数的话，以.000填充。

startTicketFileUrl子项参数

参数	名称	必选	类型	说明
name	起运磅票文件名称	是	String	需要加文件格式后缀名png/jpg/jpeg/pdf,例如：合同文件.png
url	起运磅票文件地址	可选	String	url和dataList任选一项必填
dataList	起运磅票文件对象	可选	String	base64, url和dataList任选一项必填

arrivalTicketFileUrl子项参数

参数名	必选	类型	说明
name	是	String	运抵磅票文件名称,需要加文件格式后缀名png/jpg/jpeg/pdf,例如：合同文件.png
url	可选	String	运抵磅票文件地址
dataList	可选	String	base64, 运抵磅票文件对象

carrierStatements子项参数

|参数名|名称|必选|类型|说明| |:---- |:---|:----- |----- | |documentNumber |单证号|是 |String |本资金流水单号。（是指网络货运平台内部的流水号） | |carrier |实际承运人名称|是 |String |个人车主信息/司机信息 | |actualCarrierId |实际承运人身份证号码|是 |String |个人证件号为身份证号 | |paymentMeansCode |付款方式代码|是 |String |详见代码集《付款方式代码》 | |paymentName |付款方名称|是 |String |平台名称 | |paymentAccount |付款帐户信息|是 |String |银行卡号 | |paymentBankName |付款银行|是 |String |付款银行，精确到支行，银行名称需规范，如“中国建设银行某某支行”、“中信银行某某支行”、“支付宝”等等 | |recipient |收款方名称|是 |String |实际收款人 | |receiptIdCard |收款方身份证号|是 |String |身份证号 | |receiptAccount |收款帐户信息|是 |String |银行卡号 | |receiptBankName |收款银行|是 |String |收款银行名称 | |sequenceCode |流水号/序列号|是 |String |付款银行流水号信息，银行或第三方支付平台的资金流水单号 | |monetaryAmount |实际支付金额|是 |String |资金流水金额，货币单位为人民币，保留3位小数，如整数的话，以.000填充 | |appointmentTime |合同约定时间|是 |String |合同约定时间，yyyyMMdd | |payTime |实际支付时间|是 |String |资金流水实际发生时间。yyyyMMddHHmmss | |oilCardAmount |油卡金额|选填 |String |油卡金额，货币单位为人民币，保留3位小数，如整数的话，以.000填充。 | |replaceAgreementFiles |代收协议| 可选 |List

70 KiB Raw Blame History Unescape Escape

说明

简要描述

请求URL

请求方式

请求头

请求参数

请求示例

返回参数说明

返回示例

《监管平台代码集》

上传委托合同（框架）

简要描述

请求URL

请求方式

args请求参数

enterpriseList子项参数

uploadFileInfo子项参数

请求示例

返回参数说明

返回示例

一、第一次上传

简要描述

请求URL

请求方式

请求参数

waybillInfo子项参数

consignorInfo子项参数

consigneeInfo子项参数

driverInfo子项参数

carInfo子项参数

goodsInfos子项参数

insuranceInformation子项参数

contractUrl子项参数

请求示例

返回参数说明

返回示例

二、第二次上传

简要描述

请求URL

请求方式

args请求参数

arrivalInfo子项参数

startTicketFileUrl子项参数

arrivalTicketFileUrl子项参数

carrierStatements子项参数

70 KiB

Raw Blame History