快递数据传输接口定义.doc

快递数据传输接口定义一、接口调用方式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.dll? MfcISAPICommand=接口名&名1=值1&名2=值2… 4、非关键的名值参数可以省略，名值参数顺序任意，大小写敏感 5、POST 方式请求API(action)构造建议统一为：/cgi-bin/GInfo.dll?接口名 6、原始数据打包接口(EmsApi)，特指POST数据(body)采用原始数据块形式，不进行任何源于传输需要的编码，简化接口解析 7、调试及正式使用均访问：http://网址；API密钥：abcd1234EFG<指定>二、【收费部分】订单信息传送接口<该接口为付费授权接口，需要配置ems_api.ini >2.1：接口名称 a: EmsApi, 原始数据打包接口，对于标记打包数据不进行urlencode，无名称，直接POST。

b: EmsApinv，名值对模式数据打包接口，对于值数据进行urlencode名值定义：MfcISAPICommand=EmsApinv&cdata=urlencode(打包数据)2.2：数据打包样例：1234 //客户ID,由快递公司提供2011042900057071 //订单号 //商品信息，可为多类商品大衣 //商品名称字符串类型，1-30个汉字，为第一个字段1 //商品数量整数234.56 //商品单价COAT //商品别名< GNAME >围巾< GQUANTITY >284.00SCARF张三 //收货人姓名字符串类型，最长31个汉字北京 //目的地 海淀区****街100号 //派送详细地址字符串类型，126个汉字15888888888 //收货人号码字符串类型，22位010-88888888 //收货人号码字符串类型，最长62位（含“-”）工作日送货 //备注字符串类型ac003b5fac003b5fac003b5fac003b5f //值为前面的内容附加上密钥后的MD5编码的16进制字串*标记为最后一个标记，其值为前面的内容附加上API密钥<单一密钥可在EMMis系统初始化中设置，字段名：API密钥，当前设定值为：abcd1234EFG。

多用户模式则在EMMis 客户档案中设置>后的MD5编码的16进制字串特别注意，密钥前面的字符一定为“>”标记打包数据将进行整体验证标记打包位置数据任意，但是物品子数据必须以物品名称< GNAME >作为第一个字段数据（定界需要）标记大小写敏感2.3：返回数据一，成功：正整数 [回车]运单号只要判断返回值为大于零的整数，即成功 该整数为EMMis系统中的记录ID，运单号为< NUM >标记值回传二，失败：返回一个负值，即第一个字符为“-”1：客户不存在，没有为客户建立档案，或者客户ID不正确-2：运单号重复，< NUM >定义的运单号在系统中已经存在 -3：GInfo系统未能读取初始化数据定义，不支持 -4：GInfo系统版本错误，不是授权的快递专业版 -6：没有解析到标记数据 -7：MD5签名校验失败，请注意密钥的统一！-9：数据库错误，GInfo平台问题 -11：客户ID错误，没有定义默认客户ID或者数据有问题-14：运单号数据错误< NUM >数据有问题(长度7-30 ASCII码字符)-15：快递类别(EMSKIND)错误,可以设置默认值(2.5)以避免此类错误。

2.4：请求例子http://网址/cgi-bin/GInfo.dll?MfcISAPICommand=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.DD HH: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。