Appearance
撞库(md5)
接口描述
撞库
请求路径
/v1/md5/match/{appid}
请求方式
POST
请求参数
Header
| 参数名 | 参数值 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | application/json | Y | body传递json格式参数 |
Param
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| appid | String | Y | 联系运营人员 |
Body
下方数据加密后,放入 bizData 字段,详见API 通用说明,
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| mobileMd5 | String | Y | 手机号Md5 |
| age | integer | N | 年龄 |
| city | String | N | 市一级 城市名称 |
| car | String | N | 车产情况((0:无车,1:有且接受抵押,2:有且不接受抵押)) |
| channelCode | String | Y | 渠道编码(我方提供,唯一标识渠道商) |
| userAgent | String | N | 用户终端 UA |
| clientIp | String | N | 客户 IP 地址 |
| name | String | N | 姓名(用户真实姓名,如:李娜) "李娜" |
请求示例
json
appid=10000
{
"mobileMd5": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6", // 手机号MD5(示例哈希值)
"age": 35,
"city": "北京市", // 城市名称(示例:北京市)
"clientIp": "180.168.2.123", // 合法IPv4地址(华东地区随机IP)
"car": "2", // 车产情况(有且不接受抵押)
"channelCode": "CHANNEL_008", // 渠道编码(另一种业务格式)
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36", // PC端Chrome UA
"name": "张伟" // 真实姓名(常见中文名)
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
返回参数
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| code | Integer | Y | 200成功,不等于200都是失败 |
| msg | String | N | 错误原因 |
| data | MatchResultVo | N |
data字段说明
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| outTradeNo | String | N | 撞库序列号 |
| bumpStatus | Integer | N | 撞库状态(0:成功,1:用户已存在,2:其他原因失败) |
| advertiserName | String | N | 机构名称 |
| advertiserAddress | String | N | 机构地址 |
| advertiserMobile | String | N | 机构电话 |
| agreementList | List | N | 三方机构协议列表 |
agreementList字段说明
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| name | String | N | 协议名称 |
| url | String | N | 协议地址 |
| fileType | String | N | html |
返回示例
json
{
"code": 0,
"msg": "",
"data": {
"outTradeNo": "",
"bumpStatus": 0,
"advertiserName": "",
"advertiserAddress": "",
"advertiserMobile": "" ,
"agreementList": [
{
"name": "",
"url": "",
"fileType": ""
}
]
},
"requestId": ""
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Protocol Buffers 定义
以下是使用 protobuf 格式定义的请求和响应消息结构:
proto
syntax = "proto3";
package api;
// 车产情况枚举
enum CarStatus {
CAR_STATUS_NONE = 0; // 无车
CAR_STATUS_MORTGAGE = 1; // 有且接受抵押
CAR_STATUS_NO_MORTGAGE = 2; // 有且不接受抵押
}
// 撞库状态枚举
enum BumpStatus {
BUMP_STATUS_SUCCESS = 0; // 成功
BUMP_STATUS_USER_EXISTS = 1; // 用户已存在
BUMP_STATUS_OTHER_FAILED = 2; // 其他原因失败
}
// 请求消息
message MatchRequest {
string mobileMd5 = 1; // 手机号Md5 (必填)
optional int32 age = 2; // 年龄 (可选)
optional string city = 3; // 城市名称 (可选)
optional CarStatus car = 4; // 车产情况 (可选)
string channelCode = 5; // 渠道编码 (必填)
optional string userAgent = 6; // 用户终端UA (可选)
optional string clientIp = 7; // 客户IP地址 (可选)
optional string name = 8; // 姓名 (可选)
}
// 协议信息
message AgreementInfo {
optional string name = 1; // 协议名称
optional string url = 2; // 协议地址
optional string fileType = 3; // 文件类型,如 "html"
}
// 撞库结果
message MatchResultVo {
optional string outTradeNo = 1; // 撞库序列号
optional BumpStatus bumpStatus = 2; // 撞库状态
optional string advertiserName = 3; // 机构名称
optional string advertiserAddress = 4; // 机构地址
optional string advertiserMobile = 5; // 机构电话
repeated AgreementInfo agreementList = 6; // 三方机构协议列表
}
// 响应消息
message MatchResponse {
int32 code = 1; // 200成功,不等于200都是失败
optional string msg = 2; // 错误原因
optional MatchResultVo data = 3; // 撞库结果数据
string requestId = 4; // 请求Id
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
使用方可以通过以上 proto 定义快速生成相应的代码结构和类型定义。