快递数据传输接口定义.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://网址 2.1：接口名称 a: EmsApi, 原始数据打包接口，对于标记打包数据不进行urlencode，无名称，直接POST。 b: EmsApinv，名值对模式数据打包接口，对于值数据进行urlencode。 名值定义：MfcISAPICommand=EmsApinvcdata=urlencode(打包数据) 2.2：数据打包 样例：ICID1234/ICID //客户ID,由快递公司提供NUM2011042900057071/NUM //订单号 GOODS //商品信息，可为多类商品 GNAME大衣/GNAME //商品名称字符串类型，1-30个汉字，为第一个字段 GQUANTITY1/GQUANTITY //商品数量整数GPRICE234.56/GPRICE //商品单价 GOODSACOAT/ GOODSA //商品别名 GNAME 围巾/ GNAME GQUANTITY 2/ GQUANTITY GPRICE84.00/GPRICE GOODSASCARF/ GOODSA /GOODS RECEIVER张三/RECEIVER //收货人姓名字符串类型，最长31个汉字 DES北京/DES //目的地 RADDR海淀区****街100号/RADDR //派送详细地址字符串类型，126个汉字 RSMRSMS //收货人手机号码字符串类型，22位 RPHONE010RPHONE //收货人电话号码字符串类型，最长62位（含“-”） MEMO工作日送货/MEMO //备注字符串类型 MD5ac003b5fac003b5fac003b5fac003b5f/MD5 //值为前面的内容附加上密钥后的MD5编码的16进制字串 *MD5标记为最后一个标记，其值为前面的内容附加上API密钥单一密钥可在EMMis系统初始化中设置，字段名：API密钥，当前设定值为：abcd1234EFG。多用户模式则在EMMis 客户档案中设置后的MD5编码的16进制字串。特别注意，密钥前面的字符一定为“”。 *标记打包数据将进行整体验证。标记打包位置数据任意，但是物品子数据必须以物品名称 GNAME 作为第一个字段数据（定界需要）。 *标记大小写敏感。 2.3：返回数据 一，成功：正整数 [回车]运单号 只要判断返回值为大于零的整数，即成功。 该整数为EMMis系统中的记录ID，运单号为 NUM 标记值回传 二，失败：返回一个负值，即第一个字符为“-”。 -1：客户不存在，没有为客户建立档案，或者客户ID不正确 -2：运单号重复， NUM 定义的运单号在系统中已经存在 -3：GInfo系统未能读取初始化数据定义，不支持 -4：GInfo系统版本错误，不是授权的快递专业版 -6：没有解析到MD5标记数据 -7：MD5签名校验失败，请注意密钥的统一！ -9：数据库错误，GInfo平台问题 -11：客户ID错误，没有定义默认客户ID或者ICID数据有问题 -14：运单号数据错误 NUM 数据有问题(长度7-30 ASCII码字符) -15：快递类别(EMSKIND)错误,可以设置默认值(2.5)以避免此类错误。 2.4：请求例子 http://网址NUM2011042900057071/NUMDES北京市/DESMD5862bb99813417978eea5e423f6eaf7da/MD5 *如上MD5生成例子：MD5(“NUM2011042900057071/NUMDES北京市