小包专线

追踪轨迹

查询通达国家列表

更新时间:2023-11-28 09:59:58

-简要描述
  • 查询通达国家列表(方法名称:common.country.getlist)

-公共参数
请求地址
环境 HTTP请求地址
正式环境

https://open.yw56.com.cn/api/order

测试环境 https://ejf-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://ejf-fat.yw56.com.cn/api/order?user_id=100000&method=common.country.getlist&format=json&timestamp=1655798809414&sign=bc5f1792e30936c72fa2a35efead8d73&version=V1.0

注:user_id,method,format,version,timestamp要和生成签名时使用的参数一致。sign为生成参数签名步骤生成的md5加密后得到的

-响应参数
参数 类型 描述
success Boolean 是否成功 true:成功 false:失败
code String 消息编码 0:成功 >0:失败 <0:系统异常
message String 消息内容
- data Object 实体信息
id Integer 国家Id
code String 国家代码
nameCh String 国家中文名称
nameEn String 国家英文名称
- 返回示例
{
  "success": true,
  "code": "0",
  "message": "操作成功",
  "data": [
    {
      "id": "1",
      "code": "AW",
      "nameCh": "阿鲁巴",
      "nameEn": "ARUBA"
    },
    {
      "id": "2",
      "code": "GL",
      "nameCh": "格陵兰岛",
      "nameEn": "GREENLAND"
    },
    {
      "id": "45",
      "code": "CA",
      "nameCh": "加拿大",
      "nameEn": "CANADA"
    }
  ]
}