开放平台
美国地址校验
更新时间：2025-04-30 12:55:18
-简要描述
校验美国地址 （方法名称：common.verify.us.address）
-公共参数
请求地址
| 环境 | HTTP请求地址 |
|---|---|
| 正式环境 | https://open.yw56.com.cn/api/order |
| 测试环境 | https://open-fat.yw56.com.cn/api/order |
账号信息
| 环境 | 账号 | 秘钥 apitoken |
|---|---|---|
| 正式环境 | 贵司在我司客户号； | 登录我司客户中心系统-账号管理-制单账号管理信息下查看秘钥； |
| 测试环境 | 100000 | D6140AA383FD8515B09028C586493DDB |
公共请求参数
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| user_id | String | 是 | 客户号 |
| format | String | 是 | 报文格式 默认为json格式，可选值：json |
| method | String | 是 | api名称； |
| timestamp | Long | 是 | 时间戳(毫秒级) 有效期为5分钟 |
| version | String | 是 | api版本号 可选 V1.0 |
| sign | String | 是 | 签名(根据动态规则生成) |
| data | String | 是 | 报文内容(body请求参数,放在请求体中，使用json格式) |
1.请求方式 所有接口使用 POST 方式请求，没有特殊说明 所有字符编码为utf-8； Content-Type: application/json；
2.公共请求参数放在url后面,使用&连接
3.签名规则
第一步：按字典序排列将参数拼接。具体顺序为 user_id+data+format+method+timestamp+version
第二步：将apiToken拼接到第一步的字符串的头部和尾部 apitoken+user_id+data+format+method+timestamp+version+apitoken
第三步：将第二步的结果进行md5加密； MD5(apitoken+user_id+data+format+method+timestamp+version+apitoken)
生成签名示例：
D6140AA383FD8515B09028C586493DDB100000{}jsoncommon.country.getlist1655798809414V1.0D6140AA383FD8515B09028C586493DDB
注：a.data 参数为body请求参数为json格式，并且使用压缩格式 b.MD5加密方式为32位小写；
加密后结果：bc5f1792e30936c72fa2a35efead8d73
4.请求URL示例
https://open-fat.yw56.com.cn/api/order?user_id=100000&method=common.country.getlist&format=json×tamp=1655798809414&sign=bc5f1792e30936c72fa2a35efead8d73&version=V1.0
注：user_id,method,format,version,timestamp要和生成签名时使用的参数一致。sign为生成参数签名步骤生成的md5加密后得到的
-请求参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| -receiverInfo | Object | 收件人信息 | |
| address | String | 是 | 收件人地址 |
| zipCode | String | 是 | 收件人邮编 |
| city | String | 是 |
收件人城市 |
| state | String | 是 | 收件人州（建议二字码） |
-响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否成功 true:成功 false:失败 |
| code | String | 消息编码 0:成功 >0:失败 <0:系统异常 |
| message | String | 消息内容 |
| - data | Object | 实体信息 |
| -receiverInfo | Object | 收件人信息 |
| address | String | 收件人地址 |
| city | String | 收件人城市 |
| state | String | 收件人州 |
| zipCode4 | String | 收件人邮编4位 |
| zipCode5 | String | 收件人邮编5位 |
-请求参数示例
{
"receiverInfo": {
"address": "25815 North Cabernet Lane",
"zipCode": "86334",
"city": "Paulden",
"state": "AZ"
}
}
-返回示例
{
"success": true,
"code": "0",
"message": "操作成功",
"data": {
"receiverInfo": {
"address": "25815 N CABERNET LN",
"city": "PAULDEN",
"state": "AZ",
"zipCode4": "3364",
"zipCode5": "86334"
}
}
}
