第三方API文档

第三方API文档整理

创蓝

1. 车辆违章记录查询

https://www.253.com/#/data/product_main/172

1.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/kdwl/vehicle_violation

1.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 是否必填 类型 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
carno String 车牌号
cartype String? 车辆类型01,大型汽车;02,小型汽车;03,使馆汽车;04,领馆汽车;05,境外汽车;06,外籍汽车;07,两、三轮摩托车;08,轻便摩托车;09,使馆摩托车;10,领馆摩托车;11,境外摩托车;12,外籍摩托车;13,农用摩托车;14,拖拉机;15,挂车;16,教练汽车;17,教练摩托车;18,试验汽车;19,试验摩托车;20,临时入境汽车;21,临时入境摩托车;22,临时行驶车;23,警用汽车;24,警用摩托;25,原农机号牌;51,新能源-大型汽车;52,新能源-小型汽车
frameno String 车架号,支持后6位查询,或全位查询
engineno String 发动机号,支持后6位查询,或全位查询

1.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
code int data内参数:状态码,200为成功,其它为失败
msg string data内参数:状态码对应的说明描述
data object data内参数:查询结果详细信息
+order_no string 订单号
+car_no string 车牌号
+vio_total string 违章条数
+find_total string 违章罚款合计
+score_total string 违章积分合计
+details array 违章详情;没有违章时为空数组
++vio_time string 违章时间
++vio_address string 违章地址
++vio_action string 违章行为
++vio_fine string 违章罚款
++vio_score string 违章记分
++vio_city_name string 违章所在城市名称
++vio_city string 违章所在城市代码
++vio_code string 违法代码
++col_organ string 采集机构
++decision_num string 决定书编号
++monitor_num string 监控编号
++handle_sign string 处理标记,返回值:1:未处理 未缴费 2:已处理 未缴费 3:已处理 已缴费 为空或不存在值时,默认为:未处理 未缴费。
++handle_num string 处理编号 在线处理时,传该编号。
++online_handle string 在线处理,返回值: 1:可以处理;2:不支持处理 为空或不存在结果时,默认为:不支持处理。


驾驶证信息核查

https://open.253.com/#/data/product_main/95

1. 驾驶证信息核查

1.1 协议说明
名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/dianhuabq/driver_license
1.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 类型 是否必填 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
driversLicenseNo String 驾驶证证件号
1.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
code String data内参数:返回码
message string data内参数:返回码描述
result string data内参数:返回数据信息
res string result内参数:状态码
driversLicenseNo object result内参数:驾驶证证件号
models string result内参数:准驾车型 A1 大型客车、A2 牵引车、A3 城市公交车 B1 中型客车、B2 大型货车 C1 小型汽车、C2 小型自动挡汽车、C3 三轮汽车、C4 低速载货汽车 D 三轮摩托车、E 二轮摩托车、F 轻便摩托车 M 轮式自行机械车、N 无轨电车、P 有轨电车
scoring Object result内参数:累计扣分
state string result内参数:驾驶证状态
startGetLicensingTime string result内参数:初次领证时间
endGetLicensingTime string result内参数:驾驶证有效时间至
fileNo String result内参数:档案编号

2. 驾驶证验证及计分查询

2.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/kdwl/driver_score

2.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 类型 是否必填 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
city String 省市。支持范围: 北京,天津,上海,重庆,辽宁,吉林,黑龙江, 河北,山西,陕西,山东,安徽,河南,湖北,湖南,江西,福建,云南,海南,四川,贵州,广东, 甘肃,青海,西藏,新疆,广西,内蒙古,宁夏,湖州,嘉兴,杭州,绍兴,宁波,舟山,金华,衢州,丽水,台州, 温州,徐州,连云港,宿迁,盐城,淮安,扬州,泰州,南通,镇江,南京,常州,无锡,苏州
licenseNo String 驾驶证号码
fileNo String 档案编号

2.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
code String data内参数:返回码
message string data内参数:返回码描述
result string data内参数:返回数据信息
score string result内参数:扣分总数。查询失败时,此字段不存在

3. 驾驶证信息查询

3.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/jszhy/jszxxcx

3.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 类型 是否必填 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
idCard String 驾驶证号

3.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
mvTrackId String 交易流水
guid string 会话号
detail string 服务详情
RESULT string 返回状态码
MESSAGE string 状态详情
resultCode string 返回状态码
resultMsg string 详细信息
idCard string 驾驶证号
quasiDrivingType string 准驾车型
scoring string 累计计分
driverStatus string 驾驶证状态
name string 姓名
firstIssueDate string 初次领证日期
termoFvalidity string 有效期至
fileNumber string 档案编号
trafficpolice string 状态码描述
resultMsg string 签发机关
startDate string 有效期始

4. 驾驶证基本信息核验

4.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/jszjf/drivingliver

4.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 类型 是否必填 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
name String 姓名
idCard String 身份证号
firstIssueDate String 初次领证日期 ( yyyy-MM-dd)
quasiDrivingType String 准驾车型

4.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
resultCode String 状态码(1001:验证一致;1002:验证不一致;2001:无数据,3002:参数错误;9999:服务异常)
resultMsg string 状态码描述


5. 车辆行驶证核查

https://www.253.com/#/data/product_main/174

5.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/xszhy/xszdxhy

5.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 类型 是否必填 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
plateNumber String 车架号
plateType String 车牌号
brandName String 号牌种类,车型 01,大型汽车;02,小型汽车;03,使馆汽车; 04,领馆汽车;05,境外汽车;06,外籍汽车; 07,两、三轮摩托车;08,轻便摩托车;09,使馆摩托车; 10,领馆摩托车;11,境外摩托车;12,外籍摩托车; 13,农用摩托车;14,拖拉机;15,挂车; 16,教练汽车;17,教练摩托车;20,临时入境汽车; 21,临时入境摩托车;22,临时行驶车;23,警用汽车;24,警用摩托;51,新能源大型车;52,新能源小型车
bodyColor String 车身颜色
useType String 使用性质
vehicleModelc String 车牌型号
vehicleType String 车辆类型
engineNumber String 发动机号
engineModel String 发动机型号
vin String 车架号
firstIssueDate String 初次登记日期
validityDayEnd String 校验有效日期
owner String 机动车所有人
vehicleStatus String 车辆状态
passengers String 核定载客数
retirementDate String 强制报废期止
fuelType String 燃料种类, A 汽油 B 柴油 C 电驱动(电能驱动汽车) D 混合油 E 天然气 F 液化石油气 L 甲醇 M 乙醇 N 太阳能 O 混合动力 Y 无(仅限全挂车等无动力的) Z 其他 P 插电式混合动力 Q 氢气
cc String 排量
ppsDate String 出厂日期
maxJourney String 最大功率
shaft String 轴数
wheelBase String 轴距
frontTread String 前轮距
rearTread String 后轮距
crossWeight String 总质量
curbWeight String 整备质量
loadWeight String 核定载质量
brandName String 品牌名称

5.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
guid String 会话号
mvTrackId string 交易流水号
RESULT string 状态码
MESSAGE string 状态描述信息,结果说明
detail object 服务详情
brandName string 品牌名称
bodyColor string 车身颜色
useType string 使用性质
vehicleModelc string 车牌型号
vehicleType string 车辆类型
engineNumber String 发动机号
engineModel string 发动机型号
vin string 车架号
firstIssueDate string 初次登记日期
validityDayEnd string 检验有效期止
owner string 机动车所有人
vehicleStatus string 车辆状态
passengers string 核定载客数
retirementDate string 强制报废期止
fuelType string 燃料种类
cc string 排量
ppsDate string 出厂日期
maxJourney string 最大功率(KW)
shaft string 轴数
wheelBase string 轴距
frontTread string 前轮距
rearTread string 后轮距
curbWeight string 整备质量
loadWeight string 核定载质量

6.车辆参数信息查询

有关车辆VIN和发动机相关信息验证

https://www.253.com/#/data/product_main/93

测试:

6.1 请求参数:

​ 车辆识别码vin

6.2 响应参数

{
    "tradeNo": "666226438298537984",
    "chargeStatus": 1,
    "message": "成功",
    "data": {
        "MESSAGE": "查询成功,查询有结果",
        "guid": "20200113102600_W5292w76_4055696",
        "mvTrackId": "20200113102600_chuanglan_bCVbwuzc",
        "detail": {
            "resultCode": "1001",
            "resultInfo": {
                "modelNameId": "",
                "cc": "1.4",
                "modeiId": "47021",
                "maxJourney": "96(131)/5000",
                "passengers": "5",
                "engineModel": "CFB",
                "crossWeight": "1910",
                "bodyColor": "反射银",
                "engineNumber": "J52664",
                "batch": "",
                "typeName": "速腾1.4T-A/MT豪华型惠民补贴DSG双离合(国Ⅳ)",
                "effluentStandard": "国Ⅳ",
                "modelName": "速腾1.4T-A/MT豪华型惠民补贴DSG双离合(国Ⅳ)",
                "curbWeight": "1405",
                "brandId": "",
                "modelDate": "2010",
                "vin": "LFV2A21K6A3092399",
                "dateIssuing": "",
                "oilConsumption": "6.5000",
                "brand": "大众",
                "vehicleType": "紧凑型轿车",
                "makeDate": "2010-11-02"
            },
            "resultMsg": "查得数据"
        },
        "RESULT": "1"
    },
	"code": "200000"
}

7. 车辆保养记录查询

7.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/clwbxx/clbyjucx

7.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 类型 是否必填 说明
appId String 请在api.253.com登录后获取
appKey String 请在api.253.com登录后获取
Vin String 机架号
asynAddress String 异步通知地址
brand String 品牌ID(32位)
engineNumber String 发动机号(目前“广汽传祺”、“长安铃木”此两种品牌需要传入“车架号+发动机号”)

7.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
MESSAGE String 请求结果描述
guid string 会话号
mvTrackId string 交易流水号
RESULT string 状态码
detail string 服务详情
resultInfo object 详情信息
orderId string 订单号
data array 信息详情
repairType string 维修类型
lastTime string 进厂时间
mileage String 公里数
vin string 车架号
Details string 维修详情
content string 项目详情
type string 维修类型
materials string 材料详情
carInfo object 车辆信息
engineNum string 发动机缸数
transmissionType string 变速箱类型
airBag string 安全气囊
vehicleType string 车辆类型
manufacturer string 厂家名称
doorCount string 车门数量
modelName string 车型名称
jetType string 发动机喷射类型
assemblyFactory string 组装厂
makeDate string 生产年份
vin string VIN码
journey string 功率(Kw/R)
passengers string 座位数
curbWeight string 装备质量(KW)
brandName string 品牌名称
cylinderForm string 气缸形式
stallNumber string 档位个数
carBody string 车身形式
engineModel string 发动机型号
fuelType string 燃料种类
cc string 排量(L)
saleName string 销售名称
vehicleLevel string 车辆级别
bodyColor string 车身颜色
factoryType string 厂家类型

8.银行卡四要素详细版

https://www.253.com/#/data/product_main/13

8.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/bankcard/card-auth-detail

8.2 请求参数

请求参数Body以multipart/form-data方式提交。

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
name 姓名
idNum 身份证号码,限单个
cardNo 银行卡号,限单个
mobile 非必传,银行预留手机号码,限单个,仅支持国内号码,11位

8.3 响应内容

响应body数据为JSON格式。

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录5.1响应code码
message String 响应code码解释
chargeStatus String 是否收费,枚举值:1 :收费 0:不收费
data Object
orderNo String 业务唯一流水号
handleTime String 查询时间。样例:2018-04-09 15:05:01
result String 认证结果代码。01:认证一致02:认证不一致03:认证不确定04:认证失败05:手机号码不匹配06:身份证号码不匹配07:姓名不匹配01, 02, 05, 06, 07的代码收费,其他不收费
bankName String 银行卡所属银行。样例:招商银行
cardType String 银行卡类型 样例:金穗借记卡
cardCategory String 银行卡类别 样例:借记卡
remark String 备注。样例:信息认证未通过(验证不一致)

9.银行卡四要素标准版

https://www.253.com/#/data/product_main/13

9.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/bankcard/card-auth

9.2请求参数

请求参数Body以multipart/form-data方式提交。

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
name 姓名
idNum 身份证号码,限单个
cardNo 银行卡号,限单个
mobile 非必传,银行预留手机号码,限单个,仅支持国内号码,11位

9.3 响应内容

响应body数据为JSON格式。

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录5.1响应code码
message String 响应code码解释
chargeStatus String 是否收费,枚举值:1 :收费 0:不收费
data Object
orderNo String 业务唯一流水号
handleTime String 查询时间。样例:2018-04-09 15:05:01
result String 认证结果。01:一致 02:不一致 03:认证不确定 04:认证失败。01、02收费
bankName String 银行卡所属银行。样例:招商银行
cardType String 银行卡类型 样例:金穗借记卡
cardCategory String 银行卡类别 样例:借记卡
remark String 备注。样例:信息认证未通过(验证不一致)

10.图片审核----GIF色情图像识别

10.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/nrsh/detect_gif

10.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
image 图像数据,base64编码。gif格式,每帧编码后大小< 4M,帧数不超过50,GIF图片整体大小base64编码后不超过20M

10.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 识别结果。各具体字段: class_name,分类结果名称;probability,分类结果置信度

11.图片审核 ---- 组合服务接口

11.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/nrsh/img_censor

11.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
image 待审核图片Base64编码字符串,以图片文件形式请求时必填。不能与imgUrl并存。
imgUrl 网图URL地址,以网图形式请求,图片Url需要做UrlEncode。不能与image并存。
scenes 指定本次调用的模型服务,以字符串数组表示。元素含义如下: politician:政治敏感识别 antiporn:色情识别 terror:暴恐识别 disgust:恶心图像识别 watermark:广告检测 quality:图像质量检测

11.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 识别结果。各具体字段:antiporn##result##class_name,分类标签名;antiporn##result##probability,分类标签置信度;antiporn##conclusion,分析结论;terror##result##name,分类标签名;terror##result##score,分类标签置信度;watermark##result_num,分析出的水印数量;disgust##result,是恶心图片的置信度;quality##clarity,图片清晰度;quality##aesthetic,图片美观度。

12.图片识别 ---- 车型识别

12.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/txsb/chexing

12.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
top_num 返回结果top n,默认5,该参数为可选
image 图像文件内容进行base64之后的值

12.3 响应内容

响应Body数据为JSON格式

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见响应code码
message String 响应code码解释
data Object 识别结果。各字段说明:name,车辆的品牌型号信息;score,识别结果置信度。

13.身份证校验V1(不带签名)

https://www.253.com/#/data/product_main/12?productCateCode=3&productCateName=%E5%AE%9E%E5%90%8D%E8%AE%A4%E8%AF%81

13.1.协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/idcard/id-card-auth

13.2.请求参数说明

请求参数Body以multipart/form-data方式提交

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
name 姓名
idNum 身份证号码

13.3.响应参数说明

响应body数据为JSON格式

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录5.1响应code码
message String 响应code码解释
data Object
orderNo String 业务唯一流水号。例:628291418130630
handleTime String 查询时间 例:2018-04-09 15:05:01
province String 省份
city String 市区
country String 县区
birthday String 生日,格式是yyyyMMdd
age String 年龄
gender String 性别:1:男、2:女
remark String 备注,例:一致
result String 返回结果: 01-认证一致(收费) 02-认证不一致(收费) 03-认证不确定(收费) 04-认证失败(不收费)

14.身份证校验V2(带签名版)

14.1.协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/idcard/id-card-auth/vs

14.2.请求参数说明

请求参数Body以multipart/form-data方式提交

参数名 说明
appId 请在api.253.com登录后获取
name 姓名
idNum 身份证号码
sign 签名。按appId+idNum+name顺序,将参数名称和值拼接,例如"appIdAbcd1234idNum430512198908131367name代用名",之后以appKey(控制台获得)为密钥, 使用hmacSHA1签名后经Base64编码得到。

14.3.响应参数说明

响应body数据为JSON格式

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录5.1响应code码
message String 响应code码解释
data Object
orderNo String 业务唯一流水号。例:628291418130630
handleTime String 查询时间 例:2018-04-09 15:05:01
province String 省份
city String 市区
country String 县区
birthday String 生日,格式是yyyyMMdd
age String 年龄
gender String 性别:1:男、2:女
remark String 备注,例:一致
result String 返回结果: 01-认证一致(收费) 02-认证不一致(收费) 03-认证不确定(收费) 04-认证失败(不收费)

15.运营商三要素

15.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL https://api.253.com/open/carriers/carriers-auth

15.2 请求参数说明

请求参数Body以multipart/form-data方式提交

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
name 姓名
idNum 身份证号码
mobile 手机号码

15.3 响应参数说明

响应body数据为JSON格式

字段名 类型 说明
code String 响应code码。200000:成功,其他失败。见附录5.1响应code码
message String 响应code码解释
chargeStatus String 是否收费,枚举值:1 :收费 0:不收费
data Object
orderNo String 业务唯一流水号。例:628291418130630
handleTime String 查询时间 例:2018-04-09 15:05:01
type String 运营商类型:1、中国移动2、中国联通3、中国电信
age String 年龄
gender String 性别:1:男、2:女
result String 认证结果,01-一致,02-不一致,03-不确定,04-失败
remark String 备注 ,例:一致

16. 快递物流

https://www.253.com/#/data/product_main/150

16.1 协议说明

名称 说明
协议 HTTPS POST
编码格式 UTF8
返回类型 application/json
URL api.253.com/open/kdwl/kdcx

16.2 请求参数

请求参数Body以x-www-form-urlencoded提交

参数名 说明
appId 请在api.253.com登录后获取
appKey 请在api.253.com登录后获取
timestamp 客户端时间。 格式yyyyMMddHHmmss,如20141114142239 为了在一定程度上防止“重放攻击”,平台只接受在10分钟之内的请求。如果不传或传空串,则系统不再做此字段的检测。
gzip 返回值是否用gzip方式压缩。此值为1时将压缩,其他值不压缩
com 快递公司字母简称。可以使用auto代替,此时将自动识别快递单号圆通:yuantong;高铁速递:gtsd;中通快递:zhongtong;申通快递:shentong;百世快递(原汇通):huitong;韵达快递:yunda;顺丰速运:shunfeng
nu 运单号
senderPhone 寄件人手机号后四位,顺丰需要填写
receiverPhone 收件人手机号后四位,顺丰需要填写

16.3 响应参数

响应body数据为JSON格式

字段名 类型 说明
chargeStatus Int 是否收费:1收费,0不收费
code String 响应code码。200000:成功,其他失败。见附录响应code码
message String 响应code码解释
data Object 返回对象
showapi_res_id string data内参数:本次请求ID
showapi_res_error string data内参数:错误信息的展示
showapi_res_code int data内参数:0,成功;-1,系统调用错误; -2,可调用次数或者金额为0
showapi_res_body Object data内参数:查询结果的封装
expTextName string showapi_res_body内参数:快递公司名称
expSpellName string showapi_res_body内参数:快递公司英文
mailNo string showapi_res_body内参数:快递单号
update string showapi_res_body内参数:更新时间(时间戳)
tel string showapi_res_body内参数:联系电话
data array showapi_res_body内参数:快递动态
context string showapi_res_body内data数组元素内参数:快递最新动态
time string showapi_res_body内data数组元素内参数:最新动态对应时间
status int showapi_res_body内参数:快件签收状态。 -1 待查询 0 查询异常 1 暂无记录 2 在途中 3 派送中 4 已签收 5 用户拒签 6 疑难件 7 无效单 8 超时单 9 签收失败 10 退回
possibleExpList array showapi_res_body内参数: 在auto的情况下,返回可能的快递列表simpleName快递简称、 expName快递公司名
ret_code int showapi_res_body内参数:查询是否成功
dataSize int showapi_res_body内参数:快递节点数量
msg string showapi_res_body内参数:返回说明信息
updateStr string showapi_res_body内参数:更新时间
flag string showapi_res_body内参数:成功或者失败的标识
queryTimes int showapi_res_body内参数:当前快递单号每天查询总次数

聚合API

1.VIN码查询

**接口地址:**http://v.juhe.cn/vinParse/query.php

**返回格式:**json

**请求方式:**get post

请求示例:http://v.juhe.cn/vinParse/query.php?vin=LHGCP260*****&key=您申请的key

**接口备注:**根据VIN码准确定型,获取保险车辆列表(含配置信息) 包含:车型代码,唯一标识、车型名称、品牌名称、车系名称、车组名称、排量、发动机描述、发动机型号等等。

1.1 请求参数说明:

名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
vin string 车架号

1.2 返回参数说明:

名称 类型 说明
error_code int 状态码
reason string 状态描述
result array 结果集
questionList array 返回车型问题集合
questionList说明
answerConent String 答案选项
answerValue String 答案值
question String 问题
yesFlag String 答案选项
vehicleList array 返回后市场车型列表
vehicleList说明
brandName String 品牌名称
groupCode String 车组编码
groupName String 车组名称
vehicleId String 车型代码,唯一标识
vehicleName String 车型名称
importFlag String 国产/进口
standardName String 车型俗称
displacement String 排量
yearPattern String 年款
uploadDate String 出厂日期
standardname2 String 公告号
purchasePrice String 新车购置价
gearboxType String 变速箱类型
supplyOil String 供油方式
fuelJetType String 燃油喷射形式
engineModel String 发动机型号
drivenType String 驱动形式
remark String 备注
hasConfig String 是否有更多配置
listPrice String 厂商指导价
familyName String 车系名称
seat String 座位数
cfgLevel String 配置等级
marketDate String 上市年份
vehicleSize String 外形尺寸
wheelbase String 轴距
gearNum String 变速器档数
fullWeight String 整备质量(千克)
power String 功率
bodyType String 车身结构
effluentStandard String 排放标准
vehicleColor String 车身颜色
vehlsSeri String 是否商用车(不一定有值)

2.车辆历史违章查询

2.1城市规则列表

接口地址:http://v.juhe.cn/wzHistory/city.php

**返回格式:**json

**请求方式:**get post

**请求示例:**http://v.juhe.cn/wzHistory/city.php?key=你申请的key

**接口备注:**获取城市查询违章的参数规则,建议每天更新一次

[API测试工具](javascript:frameLogin(9))

2.1.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
prefix string 对应车牌前缀
2.2.1 返回参数说明:
名称 类型 说明
error_code int 返回码(下面所有接口均有返回此字段,下面不再说明)
reason string 提示信息(下面所有接口均有返回此字段,下面不再说明)
result string 结果(下面所有接口均有返回此字段,下面不再说明)
prefix string 前缀
vin string 车架号长度((最后几位)车架长度,0为全部信息,-1为无需提供,其他为所需提供的长度值)
engine_no string 发动机号长度((最后几位)车架长度,0为全部信息,-1为无需提供,其他为所需提供的长度值)
status boolean 是否支持查询(1为支持查询,0为暂不支持查询)

2.2 查询历史违章记录

**接口地址:**http://v.juhe.cn/wzHistory/query.php

**返回格式:**json

**请求方式:**post

**请求示例:**http://v.juhe.cn/wzHistory/query.php?carNo=苏xxxxxx&vin=xxxx&engineNo=xxxx&type=02&key=你申请的key

**接口备注:**查询历史违章记录

[API测试工具](javascript:frameLogin(9))

2.2.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
carNo string 车牌号
vin string 车架号(根据城市列表的规则决定长度)
engineNo string 发动机号(根据城市列表的规则决定长度)
type string 车类型(默认02:小型车,支持大小车查询)
2.2.2 返回参数说明:
名称 类型 说明
wz_date string 违章时间
area string 违章地址
act string 违章行为
wz_code string 违法行为代码
fen int 扣分
money double 罚款金额
handled int 是否支持处理(1已处理,0未处理)
if_paid int 是否缴费(1已缴费,0未缴费)
wz_city string 违章城市

3.全国违章直连查询

3.1 获取支持城市参数接口

**接口地址:**http://v.juhe.cn/sweizhang/citys

**返回格式:**json/xml

**请求方式:**get post

**请求示例:**http://v.juhe.cn/sweizhang/citys?key=key

**接口备注:**有些城市如果维护,我们会临时下线处理

API测试工具

3.1.1 请求参数说明:
名称 必填 类型 说明
province N string 默认全部,省份简写,如:ZJ、JS
dtype N string 返回数据格式:json或xml,默认json
key Y string 在个人中心->我的数据,接口名称上方查看
3.1.2 返回参数说明:
名称 类型 说明
province_code String 省份代码
province String 省份名称
citys Array 省份下开通城市数组
city_code String 城市代码
city_name String 城市名称
engine String 是否需要发动机号0,不需要 1,需要
engineno String 需要几位发动机号0,全部 1-9 ,需要发动机号后N位
class String 是否需要车架号0,不需要 1,需要
classa String 同上,(解决java中class关键字无法映射)
classno String 需要几位车架号0,全部 1-9 需要车架号后N位

3.2 请求违章查询接口

**接口地址:**http://v.juhe.cn/sweizhang/query

**返回格式:**json/xml/jsonp

**请求方式:**post get

**请求示例:**http://v.juhe.cn/sweizhang/query?city=SH&hphm=苏L50A11&engineno=123456&key=key

**接口备注:**违章查询稳定性依赖交管方,交管方维护升级会导致部分城市查询不稳定;建议按照车牌地查询违章。

[API测试工具](javascript:frameLogin(9))

3.2.1 请求参数说明:
名称 必填 类型 说明
dtype string 返回数据格式:json或xml,默认json
callback String 返回格式选择jsonp时,必须传递
key string 在个人中心->我的数据,接口名称上方查看
city String (车牌所在地)城市代码
hphm String 号牌号码 完整7位 ,需要utf8 urlencode*
hpzl string 号牌类型,默认02:小型车,01:大型车,52:新能源小型车,51:新能源大型车
engineno String 发动机号 (具体是否需要根据城市接口中的参数填写)
classno String 车架号 (具体是否需要根据城市接口中的参数填写)
3.2.2 返回参数说明:
名称 类型 说明
error_code int 状态码
province String 查询省份代码
city String 查询城市代码
hphm String 查询的号牌号码
lists Array 违章列表
date String 违章时间
area String 违章地点
archiveno string 文书编号(不一定获取到)
act String 违章行为
code String 违章代码(仅供参考,不一定有值)
fen String 违章扣分(仅供参考,不一定有值)
money String 违章罚款(仅供参考,不一定有值)
handled String 是否处理,1处理 0未处理 空未知
hpzl string 车牌类型(02小型车)
wzcity string 违章城市(仅供参考,不一定有值)
cjjg string 采集机关(不一定有值)

3.3 根据车牌前缀获取城市参数

**接口地址:**http://v.juhe.cn/sweizhang/carPre

**返回格式:**json

**请求方式:**get

**请求示例:**http://v.juhe.cn/sweizhang/carPre.php?key=&hphm=%E6%B2%AAC

**接口备注:**根据车牌前缀或车牌号码,获取对应的城市代码及违章查询条件参数

[API测试工具](javascript:frameLogin(9))

3.3.1 请求参数说明:
名称 必填 类型 说明
key Y string 在个人中心->我的数据,接口名称上方查看
hphm String 车牌前缀(前2位)或车牌号,如:浙A;需要utf8 urlencode
isNer int 是否新能源,默认为0,可选参数0:否,1:是
3.3.2 返回参数说明:
名称 类型 说明
province String 省份名称
city_code String 城市代码
city_name String 城市名称
abbr string 车牌前缀
engine String 是否需要发动机号,0:不需要 1:需要
engineno String 需要几位发动机号0:全部 1-9 :需要发动机号后N位
classa String 是否需要车架号,0:不需要 1:需要
classno String 需要几位车架号0:全部 1-9: 需要车架号后N位

4.证件识别

https://www.juhe.cn/docs/api/id/153

4.1 支持的证件类型清单

**接口地址:**http://v.juhe.cn/certificates/typeList.php

**返回格式:**json

**请求方式:**get/post

**请求示例:**http://v.juhe.cn/certificates/typeList.php?key=您申请的appkey

**接口备注:**查询支持的证件类型清单

[API测试工具](javascript:frameLogin(9))

4.1.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
4.1.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
4.1.3 JSON返回示例:
{
    "reason": "操作成功",
    "error_code": 0,
    "result": {
        "1": "一代身份证",
        "2": "二代身份证正面",
        "3": "二代身份证证背面",
        "4": "临时身份证",
        "5": "驾照",
        "6": "行驶证",
        "7": "军官证",
        "9": "中华人民共和国往来港澳通行证(护照幅面)",
        "10": "台湾居民往来大陆通行证(护照幅面)",
        "11": "大陆居民往来台湾通行证(护照幅面)",
        "12": "签证(护照幅面)",
        "13": "护照(护照幅面)",
        "14": "港澳居民来往内地通行证正面(卡幅面)",
        "15": "港澳居民来往内地通行证背面(卡幅面)",
        "16": "户口本",
        "17": "银行卡",
        "19": "车牌",
        "20": "名片",
        "22": "卡式港澳台通行证",
        "25": "新版台湾居民往来大陆通行证正面",
        "26": "新版台湾居民往来大陆通行证背面",
        "28": "中国驾驶证副页",
        "101": "二代身份证正面背面自动分类",
        "1000": "居住证",
        "1001": "香港永久性居民身份证",
        "1002": "登机牌(拍照设备目前不支持登机牌的识别)",
        "1003": "边民证(A)(照片页)",
        "1004": "边民证(B)(个人信息页)",
        "1005": "澳门身份证",
        "1006": "领取凭证(AVA6支持)",
        "1007": "律师证(A)(信息页",
        "1008": "律师证(B) (照片页)",
        "1030": "全民健康保险卡",
        "1031": "台湾身份证正面",
        "1032": "台湾身份证背面",
        "2007":"VIN码",
        "2008":"营业执照"
    }
}

4.2 证件图片识别

**接口地址:**http://v.juhe.cn/certificates/query.php

**返回格式:**json

**请求方式:**post

**请求示例:**http://v.juhe.cn/certificates/query.php

**接口备注:**根据上传的图片文件和证件类型,进行证件识别结果返回,证件越清晰,识别准确率越高,建议图像分辨率为300DPI,建议图像文件大小在200KB以下。拍摄时请不要选择过高的分辨率拍摄,一方面造成图片过大,不利于传输,一方面分辨率过高也会影响识别率。拍摄时可以选择1280960分辨率拍摄(营业执照23002000~3000*3000),低一些的分辨率也可以选择,但是要确保图像文字清晰,银行卡识别只支持jpg格式的图片,只有状态码为0和215305时扣费

[API测试工具](javascript:frameLogin(9))

4.2.1 请求参数说明:
名称 必填 类型 说明
key string 您申请的appkey
cardType string 证件类型,参考接口1
pic MultipartFile 上传图片,大小限制在3M以内(一般建议200k以下)
userid string 用户单号
orderid string 传1表示需要返回聚合订单号,不输入或其他则不返回
4.2.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集

5.驾驶证识别

**接口地址:**http://apis.juhe.cn/drivingLicenseOcr/index

**返回格式:**json

**请求方式:**http post

**请求示例:**http://apis.juhe.cn/drivingLicenseOcr/index

**接口备注:**对机动车驾驶证所有关键字段进行识别

5.1 请求参数说明:

名称 必填 类型 说明
image string 图片,base64编码,编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式 。注意:图片需要base64编码、去掉编码头后再进行urlencode。
detect_direction int 是否检测图像朝向,默认不检测;1:检测 0:不检测
key string 在个人中心->我的数据,接口名称上方查看

5.2 返回参数说明:

名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集

6.行驶证识别

**接口地址:**http://apis.juhe.cn/vehicleLicenseOcr/index

**返回格式:**json

**请求方式:**http post

**请求示例:**http://apis.juhe.cn/vehicleLicenseOcr/index

**接口备注:**对机动车行驶证主页字段进行结构化识别

6.1 请求参数说明:

名称 必填 类型 说明
image string 图片,base64编码,编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式 。注意:图片需要base64编码、去掉编码头后再进行urlencode。
key string 在个人中心->我的数据,接口名称上方查看

6.2 返回参数说明:

名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集

6.3 JSON返回示例:

{
  "reason": "success",
  "result": {
    "result_num": 10,
    "res": [
      {
        "name": "品牌型号",
        "value": "某某牌XXXXX"
      },
      {
        "name": "发证日期",
        "value": "20100000"
      },
      {
        "name": "使用性质",
        "value": "非营运"
      },
      {
        "name": "发动机号码",
        "value": "9999999"
      },
      {
        "name": "号牌号码",
        "value": "A88888"
      },
      {
        "name": "所有人",
        "value": "代用名"
      },
      {
        "name": "住址",
        "value": "某某市某某区某某路某某号"
      },
      {
        "name": "注册日期",
        "value": "20100000"
      },
      {
        "name": "车辆识别代号",
        "value": "XXXXX1234567890000"
      },
      {
        "name": "车辆类型",
        "value": "小型轿车"
      }
    ]
  },
  "error_code": 0
}

7.身份证实名认证

https://www.juhe.cn/docs/api/id/103

7.1 身份证实名查询

**接口地址:**http://op.juhe.cn/idcard/query

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://op.juhe.cn/idcard/query?key=您申请的KEY&idcard=&realname=

**接口备注:**error_code为0或者210301时计费

7.1.1 请求参数说明:
名称 必填 类型 说明
idcard string 身份证号码
realname string 姓名
orderid int 传1时返回单号,默认不返回单号
key string 在个人中心->我的数据,接口名称上方查看
7.1.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result object 返回结果集
realname string 属result,真实姓名
idcard string 属result,身份证号
res int 属result,匹配详情,1匹配,2不匹配

JSON返回示例:

{
    "reason": "成功",
    "result": {
        "realname": "***",/*真实姓名*/
        "idcard": "******************",/*身份证号码*/
        "res": 1 /*1:匹配 2:不匹配*/
    },
    "error_code": 0
}

7.2 身份证实名查询(验签版本)

**接口地址:**http://op.juhe.cn/idcard/verifys

**返回格式:**json

**请求方式:**get/post

**请求示例:**http://op.juhe.cn/idcard/verifys?key=您申请的KEY&idcard=&realname=

**接口备注:**error_code为0时计费

7.2.1 请求参数说明:
名称 必填 类型 说明
idcard string 身份证号码
realname string 姓名(需utf8编码的urlencode)
key string 在个人中心->我的数据,接口名称上方查看
uorderid string 用户订单号(8-32位字母数字组合,需要唯一)
sign string md5(openid+appkey+idcard+realname+uorderid)32位小写,openid在个人中心查询
7.2.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result object 返回结果集
realname string 属result,真实姓名
idcard string 属result,身份证号
res int 属result,匹配详情,1匹配,2不匹配
orderid string 属result,聚合订单号
7.3.3 JSON返回示例:
{
    "reason": "成功",
    "result": {
        "realname": "***",/*真实姓名*/
        "idcard": "******************",/*身份证号码*/
        "res": 1, /*1:匹配 2:不匹配*/
        "orderid":"J103201712261751495244"/*聚合订单号*/
    },
    "error_code": 0
}

7.3 身份证实名查询(加密版)

**接口地址:**http://op.juhe.cn/idcard/queryEncry

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://op.juhe.cn/idcard/queryEncry?key=您申请的KEY&idcard=&realname=

**接口备注:**error_code为0或者210301时计费

7.3.1 请求参数说明:
名称 必填 类型
idcard string
realname string
key string
7.3.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result object 返回结果集
res int 属result,匹配详情,1匹配,2不匹配
orderid string 属result,单号
7.3.3 JSON返回示例:
加密算法:AES/ECB/PKCS5Padding,AES结果无需转小写,经过base64
加密后的数据需要urlencode传入
加密的密钥为:客户个人中心的openid经过md5后结果为小写取前16{
    "reason": "成功",
    "result": {
       "orderid":"J103201911121607589548",/*单号*/[/color]
        "res": 1 /*1:匹配 2:不匹配*/
    },
    "error_code": 0
}

8.银行卡三元素检测

https://www.juhe.cn/docs/api/id/207

8.1 银行卡三元素检测普通版

**接口地址:**http://v.juhe.cn/verifybankcard3/query

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard3/query?key=&realname=&bankcard=&idcard=

**接口备注:**根据姓名+身份证号+银行卡卡号验证是否匹配

8.1.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名
idcard string 身份证号码
bankcard string 银行卡卡号
uorderid string 用户订单号,8到32位数字字母组合,要保证唯一
isshow int 是否显示匹配信息,0默认不显示,1显示
8.1.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
jobid string 本次查询流水号
bankcard string 银行卡卡号
realname string 姓名
idcard string 身份证号码
res int 匹配结果,1:匹配 2:不匹配
message string 只有参数isshow不为空且不为0时显示
8.1.3 JSON返回示例:
{
    "reason": "成功",
    "result": {
        "jobid": "JH2071191112162139847181e7",
        "bankcard": "*************",
        "realname": "***",
        "idcard": "***************",
        "res": 2,
        "message": "认证信息不匹配,银行卡无效"
    },
    "error_code": 0
}

8.2 银行卡三元素检测(验签版)

**接口地址:**http://v.juhe.cn/verifybankcard3/verify

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard3/verify?key=&realname=&bankcard=&idcard=&sign=

**接口备注:**根据姓名+身份证号+银行卡卡号验证是否匹配

请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名,需要utf8 Urlencode
idcard string 身份证号码
bankcard string 银行卡卡号
uorderid string 用户订单号,不超过32位,要保证唯一
isshow int 是否显示匹配信息,0默认不显示,1显示
sign string md5(openid+appkey+bankcard+realname+idcard),openid在个人中心查询
返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
jobid string 本次查询流水号
bankcard string 银行卡卡号
realname string 姓名
idcard string 身份证号码
res int 匹配结果,1:匹配 2:不匹配
message string 只有参数isshow不为空且不为0时显示
JSON返回示例:
{
    "reason": "成功",
    "result": {
        "jobid": "2017052515514933954",
        "bankcard": "*****************",
        "realname": "**",
        "idcard": "*************",
        "res": 2,
        "message": "认证信息不匹配,银行卡无效"
    },
    "error_code": 0
}

8.3 银行卡鉴权2.0

**接口地址:**http://v.juhe.cn/verifybankcard3/query_v2

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard3/query_v2?key=&bankcard=&realname=&idcard=&mobile=&code=01&customer=

**接口备注:**根据姓名、身份证、银行卡、商户名称、场景检测信息是否匹配

[API测试工具](javascript:frameLogin(9))

8.3.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名
idcard string 身份证号码
bankcard string 银行卡卡号
idtype string 证件类型,具体见JSON示例。默认:01
uorderid string 用户订单号,8到32位数字字母组合,要保证唯一
isshow int 是否显示匹配信息,0默认不显示,1显示
code string 发起交易商户业务编码, 具体见JSON示例,如:01
customer string 公司名+产品名称+具体使用该服务的步骤。如:**有限公司+**APP/**产品+注册开户
8.3.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
jobid string 本次查询流水号
bankcard string 银行卡卡号
realname string 姓名
idcard string 身份证号码
res int 匹配结果,1:匹配 2:不匹配
message string 只有参数isshow不为空且不为0时显示
8.3.3 JSON返回示例:
/**code 商户业务编码		|		idtype 证件类型
01 直销银行			|		01	身份证
02 消费金融			|		02	护照
03 银行二三类账户开户		|		03	港澳证
04 征信				|		04	台胞证
05 保险				|
06 基金				|
07 证券				|
08 租赁				|
09 海关申报			|
99 其他				|
*/
{
    "reason": "成功",
    "result": {
        "jobid": "JH2071191112162139847181e7",
        "bankcard": "*************",
        "realname": "***",
        "idcard": "***************",
        "res": 2,
        "message": "认证信息不匹配,银行卡无效"
    },
    "error_code": 0
}

8.4 银行卡三元素检测加密版

**接口地址:**http://v.juhe.cn/verifybankcard3/queryEncry

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard3/queryEncry?key=&realname=&bankcard=&idcard=

**接口备注:**根据姓名+身份证号+银行卡卡号验证是否匹配

[API测试工具](javascript:frameLogin(9))

8.4.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名加密
idcard string 身份证号码加密
bankcard string 银行卡卡号加密
8.4.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
jobid string 本次查询流水号
res int 匹配结果,1:匹配 2:不匹配
message string 只有参数isshow不为空且不为0时显示
8.4.3 JSON返回示例:
加密算法:AES/ECB/PKCS5Padding,AES结果无需转小写,经过base64
加密后的数据需要urlencode传入
加密的密钥为:客户个人中心的openid经过md5后结果为小写取前16{
    "reason": "成功",
    "result": {
        "jobid": "JH2071191112162139847181e7",
        "res": 2,
        "message": "认证信息不匹配,银行卡无效"
    },
    "error_code": 0
}

8.5 银行卡鉴权2.0加密版

**接口地址:**http://v.juhe.cn/verifybankcard3/queryEncry_v2

**返回格式:**json

**请求方式:**get/post

**请求示例:**http://v.juhe.cn/verifybankcard3/queryEncry_v2?key=&bankcard=&realname=&idcard=&mobile=&code=01&customer=

**接口备注:**根据姓名、身份证、银行卡、商户名称、场景检测信息是否匹配

8.5.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名加密
idcard string 身份证号码加密
bankcard string 银行卡卡号加密
idtype string 证件类型,具体见JSON示例。默认:01
code string 发起交易商户业务编码, 具体见JSON示例,如:01
customer string 公司名+产品名称+具体使用该服务的步骤。如:**有限公司+**APP/**产品+注册开户
8.5.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
jobid string 本次查询流水号
res int 匹配结果,1:匹配 2:不匹配
message string 只有参数isshow不为空且不为0时显示
8.5.3 JSON返回示例:
/**code 商户业务编码		|		idtype 证件类型
01 直销银行			|		01	身份证
02 消费金融			|		02	护照
03 银行二三类账户开户		|		03	港澳证
04 征信				|		04	台胞证
05 保险				|
06 基金				|
07 证券				|
08 租赁				|
09 海关申报			|
99 其他				|
*/
 
加密算法:AES/ECB/PKCS5Padding,AES结果无需转小写,经过base64
加密后的数据需要urlencode传入
加密的密钥为:客户个人中心的openid经过md5后结果为小写取前16{
    "reason": "成功",
    "result": {
        "jobid": "JH2071191112162139847181e7",
        "res": 2,
        "message": "认证信息不匹配,银行卡无效"
    },
    "error_code": 0
}

9.银行卡四元素校验

https://www.juhe.cn/docs/api/id/213

9.1 银行卡四元素检测

**接口地址:**http://v.juhe.cn/verifybankcard4/queryEncry_v2

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard4/queryEncry_v2?key=&bankcard=&realname=&idcard=&mobile=&code=01&customer=

**接口备注:**根据姓名、身份证、银行卡、手机号码、商户名称、场景检测信息是否匹配

9.1.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名加密
idcard string 身份证号码加密
bankcard string 银行卡卡号加密
mobile string 手机号码加密
code string 发起交易商户业务编码, 具体见JSON示例,如:01
customer string 公司名+产品名称+具体使用该服务的步骤。如:**有限公司+**APP/**产品+注册开户;
idtype string 证件类型,具体见JSON示例。默认:01
9.1.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
res string 匹配结果,1:匹配 2:不匹配
jobid string 本次查询流水号
8.1.3 JSON返回示例:
/**code 商户业务编码		|		idtype 证件类型
01 直销银行			|		01	身份证
02 消费金融			|		02	护照
03 银行二三类账户开户		|		03	港澳证
04 征信				|		04	台胞证
05 保险				|
06 基金				|
07 证券				|
08 租赁				|
09 海关申报			|
99 其他				|
*/

 
加密算法:AES/ECB/PKCS5Padding,AES结果无需转小写,经过base64
加密后的数据需要urlencode传入
加密的密钥为:客户个人中心的openid经过md5后结果为小写取前16{
    "reason": "成功",
    "result": {
        "jobid": "JH2131191113105116991630Np",/*本次查询流水号*/ 
        "res": "2",/*验证结果,1:匹配 2:不匹配*/
        "message": "认证信息不匹配"/*描述*/
    },
    "error_code": 0
}

9.2 银行卡四元素检测

**接口地址:**http://v.juhe.cn/verifybankcard4/verify

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard4/verify?key=&realname=&idcard=&bankcard=&mobile=&sign=

**接口备注:**根据姓名、身份证、银行卡、手机号码,检测信息是否匹配

9.2.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名
idcard string 身份证号码
bankcard string 银行卡卡号
mobile string 手机号码
uorderid string 用户订单号,不超过32位,要保证唯一
sign string md5(openid+appkey+bankcard+realname+idcard+mobile),openid在个人中心查询
9.2.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
bankcard string 银行卡卡号
realname string 姓名
idcard string 身份证号码
res string 匹配结果,1:匹配 2:不匹配
jobid string 本次查询流水号
mobile string 手机号码
9.2.3 JSON返回示例:
{
    "reason": "成功",
    "result": {
        "jobid": "2015120913503797592",/*本次查询流水号*/
        "realname": "***",/*姓名*/
        "bankcard": "***************",/*银行卡卡号*/
        "idcard": "*******************",/*身份证号码*/
        "mobile": "********",/*预留手机号码*/
        "res": "2",/*验证结果,1:匹配 2:不匹配*/
        "message": "认证信息不匹配"/*描述*/
    },
    "error_code": 0
}

9.3 银行卡鉴权2.0

**接口地址:**http://v.juhe.cn/verifybankcard4/query_v2

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard4/query_v2?key=&bankcard=&realname=&idcard=&mobile=&code=01&customer=

**接口备注:**根据姓名、身份证、银行卡、手机号码、商户名称、场景检测信息是否匹配

9.3.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名
idcard string 身份证号码
bankcard string 银行卡卡号
mobile string 手机号码
code string 发起交易商户业务编码, 具体见JSON示例,如:01
customer string 公司名+产品名称+具体使用该服务的步骤。如:**有限公司+**APP/**产品+注册开户;
idtype string 证件类型,具体见JSON示例。默认:01
uorderid string 用户订单号,不超过32位,要保证唯一
9.3.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
bankcard string 银行卡卡号
realname string 姓名
idcard string 身份证号码
res string 匹配结果,1:匹配 2:不匹配
jobid string 本次查询流水号
mobile string 手机号码
9.3.3 JSON返回示例:
/**code 商户业务编码		|		idtype 证件类型
01 直销银行			|		01	身份证
02 消费金融			|		02	护照
03 银行二三类账户开户		|		03	港澳证
04 征信				|		04	台胞证
05 保险				|
06 基金				|
07 证券				|
08 租赁				|
09 海关申报			|
99 其他				|
*/
{
    "reason": "成功",
    "result": {
        "jobid": "2015120913503797592",/*本次查询流水号*/
        "realname": "***",/*姓名*/
        "bankcard": "***************",/*银行卡卡号*/
        "idcard": "*******************",/*身份证号码*/
        "mobile": "********",/*预留手机号码*/
        "res": "2",/*验证结果,1:匹配 2:不匹配*/
        "message": "认证信息不匹配"/*描述*/
    },
    "error_code": 0
}

9.4 银行卡四元素检测(加密版)

**接口地址:**http://v.juhe.cn/verifybankcard4/queryEncry

**返回格式:**json

**请求方式:**get/post

**请求示例:**http://v.juhe.cn/verifybankcard4/queryEncry?key=&bankcard=&realname=&idcard=&mobile=

**接口备注:**根据姓名、身份证、银行卡、手机号码,检测信息是否匹配

9.4.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名加密
idcard string 身份证号码加密
bankcard string 银行卡卡号加密
mobile string 手机号码加密
9.4.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
res string 匹配结果,1:匹配 2:不匹配
jobid string 本次查询流水号
9.4.3 JSON返回示例:
加密算法:AES/ECB/PKCS5Padding,AES结果无需转小写,经过base64
加密后的数据需要urlencode传入
加密的密钥为:客户个人中心的openid经过md5后结果为小写取前16{
    "reason": "成功",
    "result": {
        "jobid": "JH2131191113105116991630Np",/*本次查询流水号*/   
        "res": "2",/*验证结果,1:匹配 2:不匹配*/
        "message": "认证信息不匹配"/*描述*/
    },
    "error_code": 0
}

9.5 银行卡鉴权2.0(加密版)

**接口地址:**http://v.juhe.cn/verifybankcard4/queryEncry_v2

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://v.juhe.cn/verifybankcard4/queryEncry_v2?key=&bankcard=&realname=&idcard=&mobile=&code=01&customer=

**接口备注:**根据姓名、身份证、银行卡、手机号码、商户名称、场景检测信息是否匹配

9.5.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
realname string 姓名加密
idcard string 身份证号码加密
bankcard string 银行卡卡号加密
mobile string 手机号码加密
code string 发起交易商户业务编码, 具体见JSON示例,如:01
customer string 公司名+产品名称+具体使用该服务的步骤。如:**有限公司+**APP/**产品+注册开户;
idtype string 证件类型,具体见JSON示例。默认:01
9.5.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回码描述
res string 匹配结果,1:匹配 2:不匹配
jobid string 本次查询流水号
9.5.3 JSON返回示例:
/**code 商户业务编码		|		idtype 证件类型
01 直销银行			|		01	身份证
02 消费金融			|		02	护照
03 银行二三类账户开户		|		03	港澳证
04 征信				|		04	台胞证
05 保险				|
06 基金				|
07 证券				|
08 租赁				|
09 海关申报			|
99 其他				|
*/

 
加密算法:AES/ECB/PKCS5Padding,AES结果无需转小写,经过base64
加密后的数据需要urlencode传入
加密的密钥为:客户个人中心的openid经过md5后结果为小写取前16{
    "reason": "成功",
    "result": {
        "jobid": "JH2131191113105116991630Np",/*本次查询流水号*/ 
        "res": "2",/*验证结果,1:匹配 2:不匹配*/
        "message": "认证信息不匹配"/*描述*/
    },
    "error_code": 0
}

10.常用快递

https://www.juhe.cn/docs/api/id/43

10.1 常用快递查询API

**接口地址:**http://v.juhe.cn/exp/index

**返回格式:**json/xml

**请求方式:**http post/get

**请求示例:http://v.juhe.cn/exp/index?key=key&com=sf&no=575677355677接口地址:**http://v.juhe.cn/exp/index

**返回格式:**json/xml

**请求方式:**http post/get

**请求示例:**http://v.juhe.cn/exp/index?key=key&com=sf&no=575677355677

10.1.1 请求参数说明:
名称 必填 类型 说明
com string 需要查询的快递公司编号
no string 需要查询的快递单号
senderPhone int 寄件人手机号后四位,顺丰快递需要提供senderPhone和receiverPhone其中一个
receiverPhone int 收件人手机号后四位,顺丰快递需要提供senderPhone和receiverPhone其中一个
key string 在个人中心->我的数据,接口名称上方查看
dtype string 返回数据的格式,xml或json,默认json
10.1.2 返回参数说明:参考JSON返回示例
10.1.3 JSON返回示例:
/* 以下内容仅作为格式上的参考 */

{
  "resultcode": "200", /* 老版状态码,新用户请忽略此字段 */
  "reason": "查询物流信息成功",
  "result": {
    "company": "EMS", /* 快递公司名字 */
    "com": "ems",
    "no": "1186465887499", /* 快递单号 */
    "status": "1", /* 1表示此快递单的物流信息不会发生变化,此时您可缓存下来;0表示有变化的可能性 */,
    "status_detail": "PENDING", /* 详细的状态信息,可能为null,仅作参考。其中:
        PENDING 待查询
        NO_RECORD 无记录
        ERROR 查询异常
        IN_TRANSIT 运输中
        DELIVERING 派送中
        SIGNED 已签收
        REJECTED 拒签
        PROBLEM 疑难件
        INVALID 无效件
        TIMEOUT 超时件
        FAILED 派送失败
        SEND_BACK 退回
        TAKING 揽件 */
    "list": [
      {
        "datetime": "2016-06-15 21:44:04",  /* 物流事件发生的时间 */
        "remark": "离开郴州市 发往长沙市【郴州市】", /* 物流事件的描述 */
        "zone": "" /* 快件当时所在区域,由于快递公司升级,现大多数快递不提供此信息 */
      },
      {
        "datetime": "2016-06-15 21:46:45",
        "remark": "郴州市邮政速递物流公司国际快件监管中心已收件(揽投员姓名:侯云,联系电话:)【郴州市】",
        "zone": ""
      },
      {
        "datetime": "2016-06-16 12:04:00",
        "remark": "离开长沙市 发往贵阳市(经转)【长沙市】",
        "zone": ""
      },
      {
        "datetime": "2016-06-17 07:53:00",
        "remark": "到达贵阳市处理中心(经转)【贵阳市】",
        "zone": ""
      },
      {
        "datetime": "2016-06-18 07:40:00",
        "remark": "离开贵阳市 发往毕节地区(经转)【贵阳市】",
        "zone": ""
      },
      {
        "datetime": "2016-06-18 09:59:00",
        "remark": "离开贵阳市 发往下一城市(经转)【贵阳市】",
        "zone": ""
      },
      {
        "datetime": "2016-06-18 12:01:00",
        "remark": "到达  纳雍县 处理中心【毕节地区】",
        "zone": ""
      },
      {
        "datetime": "2016-06-18 17:34:00",
        "remark": "离开纳雍县 发往纳雍县阳长邮政支局【毕节地区】",
        "zone": ""
      },
      {
        "datetime": "2016-06-20 17:55:00",
        "remark": "投递并签收,签收人:单位收发章 *【毕节地区】",
        "zone": ""
      }
    ]
  },
  "error_code": 0 /* 错误码,0表示查询正常,其他表示查询不到物流信息或发生了其他错误 */
}

10.2 快递公司编号对照表(查询支持的快递公司)

**接口地址:**http://v.juhe.cn/exp/com

**返回格式:**json/xml/jsonp

**请求方式:**http post get

**请求示例:**http://v.juhe.cn/exp/com?key=key

10.2.1 请求参数说明:无
10.2.2 返回参数说明:无
10.2.3 JSON返回示例:
/* 以下快递公司列表仅作为格式上的说明,实际支持的列表以接口实时返回的数据为准 */

{
  "resultcode": "200",
  "reason": "查询支持的快递公司成功",
  "result": [
    {
      "com": "顺丰",
      "no": "sf"
    },
    {
      "com": "申通",
      "no": "sto"
    },
    {
      "com": "圆通",
      "no": "yt"
    },
    {
      "com": "韵达",
      "no": "yd"
    },
    {
      "com": "天天",
      "no": "tt"
    }
    ......有省略
  ],
  "error_code": 0
}

11.加油卡充值

11.1 提交加油卡充值

**接口地址:**http://op.juhe.cn/ofpay/sinopec/onlineorder

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://op.juhe.cn/ofpay/sinopec/onlineorder

接口备注:正式使用后建议个人中心绑定IP白名单。加油卡完成网上充值后,需到所充值油卡当地加油站请工作人员进行激活(圈存)操作,否则充值金额将无法生效。发票等相关问题请联系客服。 如果充值过程中,遇到http网络状态异常或返回系统异常,请务必通过订单查询接口检测订单或联系客服,不要直接做失败处理,避免造成不必要的损失!!!**

11.1.1 请求参数说明:
名称 必填 类型 说明
proid int 产品id: 10000(中石化50元加油卡)[暂不支持] 10001(中石化100元加油卡) 10002(中石化200元加油卡) 10003(中石化500元加油卡) 10004(中石化1000元加油卡) 10007(中石化任意金额充值)[暂不支持] 10008(中石油任意金额充值))
cardnum string 充值数量(产品id为10007、10008时为具体充值金额(整数),其余产品id请传固定值1);注:中石油任意冲(产品id:10008)暂时只支持100\200\500\1000
orderid string 商家订单号,8-32位字母数字组合
game_userid string 加油卡卡号,中石化:以100011开头的19位卡号、中石油:以90开头的16位卡号
gasCardTel string 持卡人手机号码,可以填写一个固定格式的手机号码,如:18900000000;为了保证充值质量,中石油充值请传递加油卡账号的绑卡手机号。
gasCardName string 持卡人姓名
chargeType int 加油卡类型 (1:中石化、2:中石油;默认为1)
key string 在个人中心->我的数据,接口名称上方查看
sign string 校验值,md5(OpenID+key+proid+cardnum+game_userid+orderid),OpenID在个人中心查询。加密结果转为32位小写
11.1.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
11.1.3 JSON返回示例:
{
    "reason": "提交充值成功",
    "result": {
        "cardnum": "1", /*充值数量*/
        "ordercash": "100", /*售价*/
        "cardname": "全国加油卡", /*充值名称*/
        "sporder_id": "S20141125221812330", /*商家订单号*/
        "game_userid": "100011320000991****", /*加油卡卡号*/
        "game_state": "0", /*充值状态:0充值中 1成功 9撤销,刚提交成功的单子状态均为充值中*/
        "uorderid": "S2014111111115" /*商户自定的订单号*/
    },
    "error_code": 0
}

11.2 订单状态查询

**接口地址:**http://op.juhe.cn/ofpay/sinopec/ordersta

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://op.juhe.cn/ofpay/sinopec/ordersta?key=&orderid=S2014111111115

**接口备注:**根据用户的订单号查询状态,本接口暂只支持查询近60天订单,请务必确认订单已经成功提交后再查询,避免造成不必要的损失;如果查询过程中,遇到http网络状态异常或错误码返回系统异常10014,或联系客服,不要直接做失败处理,避免造成不必要的损失!!!

11.2.1 请求参数说明:
名称 必填 类型 说明
orderid string 商家订单号,8-32位字母数字组合
key string 在个人中心->我的数据,接口名称上方查看
11.2.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
11.2.3 JSON返回示例:
{
    "reason": "查询成功",
    "result": {
        "cardname": "全国 中石化加油 固定面值加油卡 直充100元",/*商品名称*/
        "game_userid": "1000119000002494353",/*加油卡卡号*/
        "uordercash": "100.000",/*订单消耗金额*/
        "sporder_id": "S17070400085272603302001",/*聚合订单号*/
        "game_state": "9",/*状态 1:成功 9:失败 0:充值中*/
        "err_msg": "只能给主卡且卡状态正常的加油卡充值"/*描述,订单失败时返回失败原因*/
    },
    "error_code": 0
}

11.3 状态回调配置

**接口地址:**您接收回调新的URL地址,联系客服配置

**返回格式:**接收到回调,请返回任意字符串

**请求方式:**http post

请求示例:

API测试工具

请求参数说明:

名称 必填 类型 说明
聚合推送参数 - - -
sporder_id string Y 聚合订单号
orderid string Y 用户自定义的单号
sta int Y 充值状态1:成功 9:失败
sign string Y 校验值,md5(appkey+sporder_id+orderid) 32位小写,用于校验请求合法性
err_msg string N 状态描述信息(暂只支持油卡业务)

返回参数说明:

名称 类型 说明

JSON返回示例:

只有成功提交的订单才会有回调通知,如果提交订单是直接返回错误码,这部分单子不会发起回调通知。
详细说明可参考:http://code.juhe.cn/docs/detail/id/1565

处理成功请返回:success 或 任意字符串

重试机制:聚合数据在请求回调地址时,如果无任何内容返回或无响应,会重新发起最多3次,间隔3s左右

本回调推送内容格式适用于话费充值、油卡充值、流量充值等增值服务

如果需要状态回调的用户,如接口其他已经调试完毕,请将账号和回调地址发给在线客服,我们将回调地址配置线上。

11.4 订单状态查询

**接口地址:**http://op.juhe.cn/ofpay/sinopec/sordersta

**返回格式:**json

**请求方式:**http get/post

**请求示例:**http://op.juhe.cn/ofpay/sinopec/sordersta

**接口备注:**签名校验版,根据用户的订单号查询状态,本接口暂只支持查询近60天订单,根据用户的订单号查询状态,请务必确认订单已经成功提交后再查询,避免造成不必要的损失;如果查询过程中,遇到http网络状态异常或错误码返回系统异常10014,或联系客服,不要直接做失败处理,避免造成不必要的损失

11.4.1 请求参数说明:
名称 必填 类型 说明
key string 在个人中心->我的数据,接口名称上方查看
orderid string 商家订单号,8-32位字母数字组合
timestamp string 当前时间戳或随机数,如:1462502925
sign string 校验值,md5(OpenID+key+orderid+timestamp),OpenID在个人中心查询
11.4.2 返回参数说明:
名称 类型 说明
error_code int 返回码
reason string 返回说明
result string 返回结果集
11.4.3 JSON返回示例:
{
    "reason": "查询成功",
    "result": {
        "cardname": "全国 中石化加油 固定面值加油卡 直充100元",/*商品名称*/
        "game_userid": "1000119000002494353",/*加油卡卡号*/
        "uordercash": "100.000",/*订单消耗金额*/
        "sporder_id": "S17070400085272603302001",/*聚合订单号*/
        "game_state": "9",/*状态 1:成功 9:失败 0:充值中*/
        "err_msg": "只能给主卡且卡状态正常的加油卡充值"/*描述,订单失败时返回失败原因*/
    },
    "error_code": 0
}
发布了1 篇原创文章 · 获赞 0 · 访问量 102
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客

分享到微信朋友圈

×

扫一扫,手机浏览