司机 | 快货运Open Api

# 新增司机信息（返回审核状态）

接口名称：/driver/create/returnStatus

请求参数：

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	name	姓名	String	20	是	2-20 个字符，只允许汉字+少数民族符号 ·
2	1	phone	手机号码	String	20	是	传入号码需符合手机号码格式校验
3	1	idCard	身份证号码	String	18	是	18 位数字（末尾允许输入 X），符合身份证号校验算法
4	1	address	身份证住址	String	255	是	2-240 个字符
5	1	idCardStartDate	身份证有效开始日期	Long		是	时间戳，精确到毫秒。有效期跨度需为 5 年、10 年、20 年和长期(46 周岁以上)四种；长期证件，有效期填 2199 年 12 月 31 日
6	1	idCardEndDate	身份证有效结束日期	Long		是
7	1	driverLicenseNumber	驾驶证编号	String	20	是	身份证号或 18-20 位数字
8	1	driveType	准驾车型	String	20	是	多种准驾车型无需分隔，如“C1C2”
9	1	driverLicenseStartDate	驾驶证有效开始日期	Long		是	时间戳，精确到毫秒。有效期跨度需为 6 年、10 年和长期(46 周岁以上)三种；长期证件，有效期填 2199 年 12 月 31 日
10	1	driverLicenseEndDate	驾驶证有效结束日期	Long		是
11	1	driverLicenseIssueOrganization	驾驶证发证机关	String	50	是	不超过 50 个字符，只允许汉字
12	1	idCardIssueOrganization	身份证发证机关	String	50	否	不超过 50 个字符，只允许汉字
13	1	qualificationNumber	从业资格证号	String	20	是	身份证号或 18 位+19 位数字（末尾允许输入 X）
14	1	idCardFrontFilename	身份证正面照 Filename	String	255	是	文件名
15	1	idCardBackFilename	身份证背面照 Filename	String	255	是
16	1	licenseFilename	驾驶证主副页 Filename	String	255	是
17	1	qualificationLicenceMainFilename	从业资格证主页 Filename	String	255	否	准驾车型A和B的必传
18	1	qualificationLicenceSideFilename	从业资格证副页 Filename	String	255	否
19	1	qualificationLicenceStartDate	从业资格证生效日期	Long		条件必传	准驾车型包含A或B的必传
20	1	qualificationLicenceEndDate	从业资格证失效日期	Long		条件必传	准驾车型包含A或B的必传

对接示例：

{
  "address": "string",
  "driveType": "string",
  "driverLicenseEndDate": "1480262400000",
  "driverLicenseIssueOrganization": "string",
  "driverLicenseNumber": "string",
  "driverLicenseStartDate": "1480262400000",
  "idCard": "string",
  "idCardBackFilename": "string",
  "idCardEndDate": "1480262400000",
  "idCardFrontFilename": "string",
  "idCardIssueOrganization": "string",
  "idCardStartDate": "1480262400000",
  "licenseFilename": "string",
  "name": "string",
  "phone": "string",
  "qualificationLicenceMainFilename": "string",
  "qualificationLicenceSideFilename": "string",
  "qualificationNumber": "string",
  "qualificationLicenceStartDate": "1480262400000",
  "qualificationLicenceEndDate": "1480262400000"
}

返回参数

类型	名称	备注
String	success	是否添加成功： true-成功 false-失败
Integer	auditStatus	审核状态： 1-待审核 2-已审核 3-审核不通过

mock 数据示例

{
  "code": "00000",
  "data": {
    "auditStatus": 1,
    "success": true
  },
  "message": "请求成功"
}

# 更新司机信息（返回审核状态）

接口名称：/driver/update/returnStatus

请求参数:

序号	层级	英文名称	中文名称	类型	长度	必填	说明
1	1	name	姓名	String	20	是	2-20 个字符，只允许汉字+少数民族符号 ·
2	1	phone	手机号码	String	20	是	传入号码需符合手机号码格式校验
3	1	idCard	身份证号码	String	18	是	18 位数字（末尾允许输入 X），符合身份证号校验算法
4	1	address	身份证住址	String	255	是	2-256 个字符
5	1	idCardStartDate	身份证有效开始日期	Long		是	时间戳，精确到毫秒。有效期跨度需为 5 年、10 年、20 年和长期(46 周岁以上)四种；长期证件，有效期填 2199 年 12 月 31 日
6	1	idCardEndDate	身份证有效结束日期	Long		是
7	1	driverLicenseNumber	驾驶证编号	String	20	是	身份证号或 18-20 位数字
8	1	driveType	准驾车型	String	20	是
9	1	driverLicenseStartDate	驾驶证有效开始日期	Long		是	时间戳，精确到毫秒。有效期跨度需为 6 年、10 年和长期(46 周岁以上)三种；长期证件，有效期填 2199 年 12 月 31 日
10	1	driverLicenseEndDate	驾驶证有效结束日期	Long		是
11	1	driverLicenseIssueOrganization	驾驶证发证机关	String	50	是	不超过 50 个字符，只允许汉字
12	1	idCardIssueOrganization	身份证发证机关	String	50	否	不超过 50 个字符，只允许汉字
13	1	qualificationNumber	从业资格证号	String	20	是	身份证号或 18 位+19 位数字（末尾允许输入 X）
14	1	idCardFrontFilename	身份证正面照 Filename	String	255	是	文件名
15	1	idCardBackFilename	身份证背面照 Filename	String	255	是
16	1	licenseFilename	驾驶证主副页 Filename	String	255	是
17	1	qualificationLicenceMainFilename	从业资格证主页 Filename	String	255	否	准驾车型A和B的必传
18	1	qualificationLicenceSideFilename	从业资格证副页 Filename	String	255	否
19	1	qualificationLicenceStartDate	从业资格证生效日期	Long		条件必传	准驾车型包含A或B的必传
20	1	qualificationLicenceEndDate	从业资格证失效日期	Long		条件必传	准驾车型包含A或B的必传

示例：

{
  "address": "string",
  "driveType": "string",
  "driverLicenseEndDate": 1480262400000,
  "driverLicenseIssueOrganization": "string",
  "driverLicenseNumber": "string",
  "driverLicenseStartDate": 1480262400000,
  "idCard": "string",
  "idCardBackFilename": "string",
  "idCardEndDate": 1480262400000,
  "idCardFrontFilename": "string",
  "idCardIssueOrganization": "string",
  "idCardStartDate": 1480262400000,
  "licenseFilename": "string",
  "name": "string",
  "phone": "string",
  "qualificationLicenceMainFilename": "string",
  "qualificationLicenceSideFilename": "string",
  "qualificationNumber": "string",
  "qualificationLicenceStartDate": "1480262400000",
  "qualificationLicenceEndDate": "1480262400000"
}

返回参数

类型	名称	备注
String	success	是否编辑成功： true-成功 false-失败
Integer	auditStatus	审核状态： 1-待审核 2-已审核 3-审核不通过

mock 数据示例

{
  "code": "00000",
  "data": {
    "auditStatus": 1,
    "success": true
  },
  "message": "请求成功"
}

# 根据身份证号查询司机

接口名称：/driver/queryByIdCard

请求参数:

类型	名称	备注	必填
array[string]	idCards	身份证号集合	是

返回参数：

类型	名称	备注
Long	id	司机 ID
Long	userId	用户 ID
Long	carrierId	承运人 ID
String	name	姓名
String	phone	手机号码
String	idCard	身份证号码
String	address	身份证住址
String	idCardFrontFilename	身份证正面照 Filename
String	idCardBackFilename	身份证背面照 Filename
String	licenseFilename	驾驶证主副页 Filename
String	qualificationNumber	从业资格证号
String	qualificationLicenceMainFilename	从业资格证主页 Filename
String	qualificationLicenceSideFilename	从业资格证副页 Filename
Long	qualificationLicenceStartDate	从业资格证生效日期
Long	qualificationLicenceEndDate	从业资格证失效日期
String	driverLicenseNumber	驾驶证编号
String	driveType	准驾车型
Long	driverLicenseStartDate	驾驶证有效开始日期
Long	driverLicenseEndDate	驾驶证有效结束日期
String	driverLicenseIssueOrganization	驾驶证发证机关
Long	idCardStartDate	身份证有效开始日期
Long	idCardEndDate	身份证有效结束日期
String	idCardIssueOrganization	身份证发证机关
Long	companyId	企业 ID
String	remark	备注
Integer	auditStatus	审核状态： 1-待审核 2-已审核 3-审核不通过 4-快过期 5-过期 6-未提交
Integer	contractStatus	合同状态：0-未签约，1-等待签约，2-有效，3-快到期，4-已到期，5-作废
Integer	accountStatus	开户状态：-1,待开户，0，开户中；1，可用；2：已禁用
Long	auditTime	审核时间
Long	creatorCompanyId	创建企业 ID
String	selfImageFilename	自拍照片 Filename
List<ExamineItemDTO>	refuseReason	审核拒绝原因
ExamineItemDTO
Boolean	checked	是否选中
Long Boolean	custom	是否自定义原因
String	item	审查项目(调用方自定义)
Integer	result	审批项对应的审批结果代码(调用方自定义)
String	remarks	审查项目备注

mock 数据示例

{
  "code": "00000",
  "data": [
    {
      "id": 69,
      "userId": 35,
      "carrierId": 29,
      "name": "String",
      "phone": "String",
      "idCard": "String",
      "address": "String",
      "idCardFrontFilename": "String",
      "idCardBackFilename": "String",
      "licenseFilename": "String",
      "qualificationNumber": "String",
      "qualificationLicenceMainFilename": "String",
      "qualificationLicenceSideFilename": "String",
      "qualificationLicenceStartDate": "1480262400000",
      "qualificationLicenceEndDate": "1480262400000",
      "driverLicenseNumber": "String",
      "driveType": "A2B2",
      "driverLicenseStartDate": 1609430400000,
      "driverLicenseEndDate": 1798732800000,
      "driverLicenseIssueOrganization": "String",
      "idCardStartDate": 1480262400000,
      "idCardEndDate": 2111414400000,
      "idCardIssueOrganization": "String",
      "companyId": null,
      "remark": "审核通过",
      "auditStatus": 2,
      "auditTime": null,
      "creatorCompanyId": null,
      "selfImageFilename": null,
      "refuseReason": null
    }
  ],
  "message": "请求成功"
}

# 司机审核回调通知

1.请求头会携带sign参数，用于鉴权

serviceName : auditDriver

接口名称：由接入方提供回调地址

请求参数

序号	层级	英文名称	中文名称	类型	长度	是否必填	说明
1	1	serviceName	服务名	String		是	司机审核结果通知
2	1	apiId	接入appId	String		是	商家企业ID
3	1	idCard	身份证号	String		是
4	1	auditStatus	审核结果	int	1	是	1-成功, 2-拒绝
5	1	auditItems	结果文本	String		否

mock 数据示例

{
	"apiId": "9fa5c1643b454f7ab2e026082d610e6b",
	"auditItems": "[{\"checked\":false,\"custom\":false,\"item\":\"driverLicenseEndDate\",\"remarks\":\"驾驶证有效期有误\",\"result\":1},{\"checked\":false,\"custom\":false,\"item\":\"driveType\",\"remarks\":\"准驾车型有误\",\"result\":1}]",
	"auditStatus": 2,
	"idCard": "13092219820222601X",
	"serviceName": "auditDriver"
}

返回参数

序号	英文名称	中文名称	类型	说明
1	code	结果码	String	1-成功 2-失败
2	message	结果文本	String	结果文本

mock 数据示例

{
        "code": "00000",
        "message": "请求成功"
 }

← 货主车辆 →