快递数据传输接口定义

一、接口调用方式1、下述接口遵从HTTP(1.
0/1.
1)协议,接口由http://网址/cgi-bin/GInfo.
dll提供.
2、建议使用POST方式发送请求,但是所有支持名值对的接口都可以使用GET方式.

3、请求可以为如下任一表述:a:/cgi-bin/GInfo.
dll接口名&名1=值1&名2=值2…b:/cgi-bin/GInfo.
dll接口名名1=值1&名2=值2…c:/cgi-bin/GInfo.
dllMfcISAPICommand=接口名&名1=值1&名2=值2…4、非关键的名值参数可以省略,名值参数顺序任意,大小写敏感.
5、POST方式请求API(action)构造建议统一为:/cgi-bin/GInfo.
dll接口名6、原始数据打包接口(EmsApi),特指POST数据(body)采用原始数据块形式,不进行任何源于传输需要的编码,简化接口解析.

7、调试及正式使用均访问:http://网址;API密钥:abcd1234EFG二、【收费部分】订单信息传送接口2.
1:接口名称a:EmsApi,原始数据打包接口,对于标记打包数据不进行urlencode,无名称,直接POST.
b:EmsApinv,名值对模式数据打包接口,对于值数据进行urlencode.
名值定义:MfcISAPICommand=EmsApinv&cdata=urlencode(打包数据)2.
2:数据打包样例:1234//客户ID,由快递公司提供2011042900057071//订单号//商品信息,可为多类商品大衣//商品名称字符串类型,1-30个汉字,为第一个字段1//商品数量整数234.
56//商品单价COAT//商品别名围巾284.
00SCARF张三//收货人姓名字符串类型,最长31个汉字北京//目的地海淀区****街100号//派送详细地址字符串类型,126个汉字15888888888//收货人手机号码字符串类型,22位010-88888888//收货人电话号码字符串类型,最长62位(含"-")工作日送货//备注字符串类型ac003b5fac003b5fac003b5fac003b5f//值为前面的内容附加上密钥后的MD5编码的16进制字串*标记为最后一个标记,其值为前面的内容附加上API密钥后的MD5编码的16进制字串.
特别注意,密钥前面的字符一定为">".

*标记打包数据将进行整体验证.
标记打包位置数据任意,但是物品子数据必须以物品名称作为第一个字段数据(定界需要).

*标记大小写敏感.
2.
3:返回数据一,成功:正整数[回车]运单号只要判断返回值为大于零的整数,即成功.
该整数为EMMis系统中的记录ID,运单号为标记值回传二,失败:返回一个负值,即第一个字符为"-".
-1:客户不存在,没有为客户建立档案,或者客户ID不正确-2:运单号重复,定义的运单号在系统中已经存在-3:GInfo系统未能读取初始化数据定义,不支持-4:GInfo系统版本错误,不是授权的快递专业版-6:没有解析到标记数据-7:MD5签名校验失败,请注意密钥的统一!
-9:数据库错误,GInfo平台问题-11:客户ID错误,没有定义默认客户ID或者数据有问题-14:运单号数据错误数据有问题(长度7-30ASCII码字符)-15:快递类别(EMSKIND)错误,可以设置默认值(2.
5)以避免此类错误.
2.
4:请求例子http://网址/cgi-bin/GInfo.
dllMfcISAPICommand=EmsApinv&cdata=2011042900057071北京市862bb99813417978eea5e423f6eaf7da*如上MD5生成例子:MD5("2011042900057071北京市abcd1234EFG")=="862bb99813417978eea5e423f6eaf7da"*如上MD5值是在GBK编码下的结果,如果使用UTF-8编码,则值会不一样.
MD5仅认证数据来源,与字符集编码无关.

*URLEncode(如果需要)必须在MD5码生成之后进行.
*如果数据字符编码不是默认定义的编码(快递公司确定),可在打包数据中提供编码类型.
比如Big5:950*目前支持的编码有:65001(UTF-8),936(GBK),950(BIG5),932(SHIFT-JIS).
2.
5:全部字段标记定义如下:ICID=ICID=1[客户ID,客户在EMMis系统中流水号]ITEMTYPE=ITEMTYPE=1[快件类型,0表示文件,1表示包裹,2表示防水袋]DATE=DATE=[业务日期,YYYY.
MM.
DDHH:MM:SS]PAYWAY=PAYWAY=0[付款方式,0代表月结,1代表现付,2代表到付]INPUT=INPUT=API直传[录单人,0-30字符]EMSKIND=EMSKIND=FedEx[快递类别,1-15字符]ADDRFROM=ADDRFROM=上海[出发地,0-62字符]DES=DES=[目的地,0-62字符]NUM=NUM=[内单号,必须唯一,7-30字符]TITEM=TITEM=1[件数,整数]WEIGHTT=WEIGHTT=0.
0[计费重量,公斤,精确到三位小数]AMOUNTT=AMOUNTT=0.
0[总运费,精确到两位小数]SENDER=SENDER=[发件人姓名,0-30字符]DEPART=DEPART=[发件人所属部门,0-30字符]SPHONE=SPHONE=[发件电话,0-62字符]SUINTNAME=SUINTNAME=[发件单位,0-126字符]SPOSTCODE=SPOSTCODE=[发件邮编,0-15字符]SADDR=SADDR=[发件地址,0-126字符]SCOUNTRY=SCOUNTRY=[发件国家,0-63字符]SCITY=SCITY=[发件城市,0-63字符]SPROVINCE=SPROVINCE=[发件省州,0-30字符]SSMS=SSMS=[发件短信号码,0-22字符]SEMAIL=SEMAIL=[发件电子信箱,0-63字符]RECEIVER=RECEIVER=[收件人姓名,0-62字符]RPHONE=RPHONE=[收件电话,0-62字符]RUINTNAME=RUINTNAME=[收件单位,0-254字符]RPOSTCODE=RPOSTCODE=[收件邮编,0-15字符]RADDR=RADDR=[收件地址,0-254字符]RCOUNTRY=RCOUNTRY=[收件国家,0-128字符]RCITY=RCITY=[收件城市,0-128字符]RPROVINCE=RPROVINCE=[收件省州,0-62字符]RSMS=RSMS=[收件短信号码,0-22字符]REMAIL=REMAIL=[收件电子信箱,0-63字符]MARK=MARK=[标签,0-15字符]MEMO=MEMO=[备注,0-254字符]SIZE=SIZE=[体积,长*宽*高,单位厘米,如:30*20*50]WEIGHTB=WEIGHTB=0.
0[称重,公斤,精确到三位小数,默认与计费重量相同]GOODS=GOODS=[物品数据,内嵌字段:品名、数量、单价如后]GNAME=GNAME=[物品名称,1-62]GQUANTITY=GQUANTITY=1[物品数量,整数]GPRICE=GPRICE=0.
0[物品单价,精确到两位小数,选用]GOODSA=GOODSA=[物品别名,0-62字符,选用]GCODEA=GCODEA=[物品甲码,0-62字符,选用]GCODEB=GCODEB=[物品乙码,0-62字符,选用]GCODEC=GCODEC=[物品丙码,0-62字符,选用]GCUSTOM=GCUSTOM=0.
0[关税,精确到两位小数,选用]GCRATE=GCRATE=0.
0[税率,精确到三位小数,选用]PACKING=PACKING=[包装,0-15字符]TRANSNOTE=TRANSNOTE=[托运备注,0-62字符]DVALUE=DVALUE=0.
0[声明价,精确到两位小数]IVALUE=IVALUE=0.
0[保险价,精确到两位小数]MONEY=MONEY=CNY[计价币种,标准三字代码]ORIGIN=ORIGIN=CN[原产地,标准二字代码]PAYDIR=PAYDIR=PP[结算指示,PP代表预付,CC托收,COD到付,DP第三方支付]CHECKPOINT=CHECKPOINT=[检查点,0-15字符]AMOUNTR=AMOUNTR=0.
0[从下家返运费,精确到两位小数,到付运费分割]AMOUNTC=AMOUNTC=0.
0[向客户还运费,精确到两位小数,到付运费分割]FGOODST=FGOODST=0.
0[代收总货款,精确到两位小数]FGOODSC=FGOODSC=0.
0[向客户还代收货款,精确到两位小数,代收货款分割]CRESERVE=CRESERVE=[留用字符串,0-30字符]IRESERVE=IRESERVE=0[留用整数]CNNO=CNNO=[转单号,0-30字符]CRNO=CRNO=[参考号,0-30字符]CCNO=CCNO=[报关号,0-30字符]CBY1=CBY1=[备用一,0-63字符]CBY2=CBY2=[备用二,0-63字符]CBY3=CBY3=[备用三,0-63字符]CBY4=CBY4=[备用四,0-63字符]CBY5=CBY5=[备用五,0-254字符]三、【免费部分】已完成订单信息查询接口3.
1:接口名称:EmsTrackState3.
2:接口参数:共2个cno:运单号,(每个单号长度7-30字符),如果ntype=10,多票详细数据查询,逗号","分割ntype:追踪选择,默认值为0(单票状态查询,仅返回一个状态数字),+10:多票(包括单票)详细数据查询,多票运单号之间用半角逗号","分割,一次最多50个单号.

+10000:返回Json格式数据.
3.
3:返回数据:为CSV格式:运单号,状态,签收日期时间,"签收人"返回值含义:-9:数据库内部错误-5:服务器版本类型不支持-4:系统未获有效注册-3:运单号长度不对(8-30)-2:没有查询结果//--记录状态含义0:未发送1:已发送2:转运中3:送达4:超时5:扣关6:地址错误7:快件丢失8:退件9:其它异常10:销毁3.
4:例子:a:http://网址/cgi-bin/GInfo.
dllEmsTrackState&cno=086010007473b:http://网址/cgi-bin/GInfo.
dllEmsTrackState&cno=086010007473&ntype=10c:http://网址/cgi-bin/GInfo.
dllEmsTrackState&cno=086010007473,086010007474,086010007150,086010007475,086010007476,086010007477&ntype=10四、【免费部分】订单追踪详细信息查询接口——仅单票查询4.
1:接口名称:EmsApiTrack4.
2:接口参数:共3个cno:运单号(长度7-30字符),默认查询顺序:内单号,转单号ntype:语言等选择,默认:0,系统设置;100:强制中文;101:强制英文+1000:(调整查询顺序:参考号,内单号,转单号).
+10000:返回Json格式数据.
cp:语言编码,默认936,GBK;支持65001(utf-8)4.
3:返回数据:返回值:第一行皆为状态行,失败返回一个负数:-9:系统错误;-102:运单不存在.
成功返回100,后面为XML简易数据包装100取件日期时间出发地目的地件数重量状态签收日期时间签收人日期时间服务地点详细信息.
.
.
.
.
.
附加信息头4.
4:例子:a:http://网址/cgi-bin/GInfo.
dllEmsApiTrack&cno=086010007473b:http://网址/cgi-bin/GInfo.
dllMfcISAPICommand=EmsApiTrack&cno=0860100075944.
5:*注意ems.
ini的相关配置:"追踪数据提供转单信息=0"五、【收费部分】转单号查询5.
1:接口名称:EmsApiQuery5.
2:接口参数:共4个icid:客户ID,必须.
cno:运单号,每个单号长度7-30字符,逗号","分割,小于4000字节.
md5:数字签名,必须.
=MD5(运单号+密钥)ntype:选择项,默认值为0,+1000:返回"快递类别".
+10000:返回Json格式数据.
5.
3:返回数据:为CSV格式:内单号,转单号,快递类别返回值含义:-9:数据库内部错误-5:服务器版本类型不支持-4:系统未获有效注册-3:运单号长度不对(7-30)-7:MD5验证失败5.
4:例子:a:http://网址/cgi-bin/GInfo.
dllEmsApiQuery&icid=79&cno=086010007473&md5=ac003b5fac003b5fac003b5fac003b5fb:http://网址/cgi-bin/GInfo.
dllEmsApiQuery&icid=79&cno=086010007473,556623222,8834444444&md5=ac003b5fac003b5fac003b5fac00aaaa六、【免费部分】获取快递类别(快递产品、渠道)列表——6.
1:接口名称:ajxEmsQueryEmsKind6.
2:接口参数:共1个wcid:用户网站ID,可以不提供.
6.
3:返回数据:JSON6.
4:例子:a:http://exp.
xingyuehang.
com/cgi-bin/GInfo.
dllajxEmsQueryEmsKindb:http://exp.
xingyuehang.
com/cgi-bin/GInfo.
dllajxEmsQueryEmsKind&w=szxjwl*请在ems.
ini中定义"快递类别名称转换定义选择=1"七、【收费部分】运单号提取7.
1:接口名称:EmsApiGetNo7.
2:接口参数:共4个icid:客户ID,必须.
cemskind:快递类别,1-15字节.
timestamp:时间戳,1970.
1.
10:0:0到现在的毫秒数(UTC),13位数字.
cp:字符编码,默认936(GBK编码).
可以提供65001(UTF-8)编码(&cp=65001)md5:数字签名,必须.
=MD5(快递类别+时间戳+密钥)7.
3:返回数据:为CSV格式:状态,运单号返回值状态含义:大于零成功-9:数据库内部错误-5:服务器版本类型不支持-4:系统未获有效注册-3:快递类别不支持或单号已用尽或排队等待超时(太多的请求)-6:时间戳验证失败-7:MD5验证失败7.
4:例子:a:http://网址/cgi-bin/GInfo.
dllEmsApiGetNo&icid=79&cemskind=EMS国际×tamp=1405103661123&md5=fb4477ba6f37601698b60aac8f294107*请在ems.
ini中定义"启用运单号预设提取=1"八、【免费部分】获取服务器动态IP地址——没有独立IP的用户8.
1:接口名称:EmsGInfoIP8.
2:接口参数:共2个wcid:用户网站IDr:随机小数,避免浏览器从缓存中读取数据返回8.
3:返回数据:点分隔的IP地址(如123.
23.
33.
4)8.
4:例子:a:http://exp.
xingyuehang.
com/cgi-bin/GInfo.
dllEmsGInfoIP&w=szxjwl&r=0.
22334555b:http://www.
neogate.
cn/cgi-bin/GInfo.
dllEmsGInfoIP&w=jisuex&r=0.
778899552***域名可以为客户网站所在钮门虚拟主机名(如:www.
neogate.
cn),也可以为客户的域名(如:exp.
xingyuehang.
com).