预约取件接口API接口文档-JAVA方法.docx

预约取件接口API接口文档-JAVA方法一、接口API（1）在线下单接口（预约取件接口）是提供给独立电商、仓储管理系统、物流供应链等物流系统平台使用的下单接口。（2）为客户解决在线发货需求，商户通过网络选择快递公司发送请求通知快递公司有快递要发货。（3）订单编号（OrderCode）不可重复提交，重复提交系统会返回具体错误代码。（4）接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)：application/x-www-form-urlencoded;charset=utf-8。（5）接口地址： API测试地址：http:/testapi.kdniao.cc:8081/api/OOrderServiceAPI正式地址：http:/api.kdniao.cc/api/OOrderService（6）接口使用：在快递鸟网站申请接口KEY请求系统级参数说明：参数名称类型说明必须要求RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。REBusinessIDString商户ID，请在我的服务页面查看。RRequestTypeString请求指令类型：1001RDataSignString数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。RDataTypeString请求、返回数据类型：只支持JSON格式R备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）二、接口参数请求内容字段定义参数类型说明必须要求WarehouseIDString仓库标识OWarehouseAddressString仓库地址OCallBackString商户标识OMemberIDString会员标识OShipperCodeString快递公司编码RLogisticCodeString快递单号OOrderCodeString订单编号RMonthCodeString月结编码CPayTypeInt邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付RExpTypeInt快递类型：1-标准快件RCostDouble寄件费（运费）OOtherCostDouble其他费用OReceiverCompanyString收件人公司ONameString收件人RTelString电话与手机，必填一个RMobileStringPostCodeString收件人邮编OProvinceNameString收件省（如广东省，不要缺少“省”）RCityNameString收件市（如深圳市，不要缺少“市”）RExpAreaNameString收件区（如福田区，不要缺少“区”或“县”）OAddressString收件人详细地址RSenderCompanyString发件人公司ONameString发件人RTelString电话与手机，必填一个RMobileStringPostCodeString发件人邮编OProvinceNameString发件省（如广东省，不要缺少“省”）RCityNameString发件市（如深圳市，不要缺少“市”）RExpAreaNameString发件区（如福田区，不要缺少“区”或“县”）OAddressString发件人详细地址RStartDateString上门取货时间段:yyyy-MM-dd HH:mm:ss格式化，本文中所有时间格式相同OEndDateStringOWeightDouble物品总重量kgOQuantityInt件数/包裹数OVolumeDouble物品总体积m3ORemarkString备注OAddServicesAddServiceNameString增值服务名称OValueString增值服务值OCustomerIDString客户标识（选填）OCommoditysCommodityGoodsNameString商品名称RGoodsCodeString商品编码OGoodsquantityInt商品数量OGoodsPriceDecimal商品价格OGoodsWeightDecimal商品重量OGoodsDescString商品描述OGoodsVolDouble商品体积m3O返回参数定义参数名称类型说明必须要求EBusinessIDString用户IDROrderOrderCodeString订单编号RShipperCodeString快递公司编码RLogisticCodeString快递单号OSuccessBool成功与否RResultCodeString结果编码RReasonString失败原因OUniquerRequestNumberString唯一标识R三、示例请求示例 JSONOrderCode: 012657018199,ShipperCode: SF,PayType: 1,MonthCode: 7553045845,ExpType: 1,Cost: 1.0,OtherCost: 1.0,Sender: Company: LV, Name: Taylor, Mobile: ProvinceName: 上海, CityName: 上海, ExpAreaName: 青浦区, Address: 明珠路,Receiver: Company: GCCUI, Name: Yann, Mobile: ProvinceName: 北京, CityName: 北京, ExpAreaName: 朝阳区, Address: 三里屯街道,Commodity: GoodsName: 鞋子, Goodsquantity: 1, GoodsWeight: 1.0 ,AddService: Name: COD, Value: 1020 ,Weight: 1.0,Quantity: 1,Volume: 0.0,Remark: 小心轻放返回示例 JSON失败： EBusinessID: 1237100, Success: false, ResultCode: 105, Reason: 该订单已经存在，请勿重复操作, UniquerRequestNumber:451d3c7c-b428-490a-a4ed-e368f15f6c74成功： EBusinessID: 1237100, Success: true, Order: OrderCode: 012657018199, ShipperCode : SF , LogisticCode : , ResultCode: 100, Reason: 四、demoJAVA对接import java.io.BufferedReader;import java.io.IOException; import java.io.InputStreamReader;import java.io.OutputStreamWriter;import java.io.UnsupportedEncodingException;import .HttpURLConnection;import .URL;import .URLEncoder;import java.util.HashMap;import java.util.Map;import ernal.impl.dv.util.Base64;import java.security.MessageDigest; public class KdGoldAPIDemo /电商IDprivate String EBusinessID=请申请;/电商加密私钥，注意保管，不要泄漏private String AppKey=请申请;/测试请求url private string ReqURL = http:/testapi.kdniao.cc:8081/api/oorderservice;/正式请求url/private string ReqURL = http:/api.kdniao.cc/api/OOrderService;/* * Json方式 在线下单 * throws Exception */public String orderOnlineByJson() throws ExceptionString requestData= OrderCode: 012657700312, + ShipperCode:YTO, + PayType:1, + ExpType:1, + Cost:1.0, + OtherCost:1.0, + Sender: + + Company:LV,Name:Taylor,MobileProvinceName:上海,CityName:上海,ExpAreaName:青浦区,Address:明珠路73号, + Receiver: + + Company:GCCUI,Name:Yann,MobileProvinceName:北京,CityName:北京,ExpAreaName:朝阳区,Address:三里屯街道雅秀大厦, + Commodity: + + GoodsName:鞋子,Goodsquantity:1,GoodsWeight:1.0, + AddService: + + Name:COD,Value:1020, + Weight:1.0, + Quantity:1, + Volume:0.0, + Remark:小心轻放, + Commodity: + + GoodsName:鞋子, + Goodsquantity:1, + GoodsWeight:1.0 + ;Map params = new HashMap();params.put(RequestData, urlEncoder(requestData, UTF-8);params.put(EBusinessID, EBusinessID);params.put(RequestType, 1001);String dataSign=encrypt(requestData, AppKey, UTF-8);params.put(DataSign, urlEncoder(dataSign, UTF-8);params.put(DataType, 2);String result=sendPost(ReqURL, params);/根据公司业务处理返回的信息.return result;/* * MD5加密 * param str 内容 * param charset 编码方式 * throws Exception */SuppressWarnings(unused)private String MD5(String str, String charset) throws Exception MessageDigest md = MessageDigest.getInstance(MD5); md.update(str.getBytes(charset); byte result = md.digest(); StringBuffer sb = new StringBuffer(32); for (int i = 0; i result.length; i+) int val = resulti & 0xff; if (val = 0xf) sb.append(0); sb.append(Integer.toHexString(val); return sb.toString().toLowerCase();/* * base64编码 * param str 内容 * param charset 编码方式 * throws UnsupportedEncodingException */private String base64(String str, String charset) throws UnsupportedEncodingExceptionString encoded = Base64.encode(str.getBytes(charset);return encoded; SuppressWarnings(unused)private String urlEncoder(String str, String charset) throws UnsupportedEncodingExceptionString result = URLEncoder.encode(str, charset);return result;/* * 电商Sign签名生成 * param content 内容 * param keyValue Appkey * param charset 编码方式 * throws UnsupportedEncodingException ,Exception * return DataSign签名 */SuppressWarnings(unused)private String encrypt (String content, String keyValue, String charset) throws UnsupportedEncodingException, Exceptionif (keyValue != null)return base64(MD5(content + keyValue, charset), charset);return base64(MD5(content, charset), charset); /* * 向指定 URL 发送POST方法的请求 * param url 发送请求的 URL * param params 请求的参数集合 * return 远程资源的响应结果 */SuppressWarnings(unused)private String sendPost(String url, Map params) OutputStreamWriter out = null; BufferedReader in = null; StringBuilder result = new StringBuilder(); try URL realUrl = new URL(url); HttpURLConnection conn =(HttpURLConnection) realUrl.openConnection(); / 发送POST请求必须设置如下两行 conn.setDoOutput(true); conn.setDoInput(true); / POST方法 conn.setRequestMethod(POST); / 设置通用的请求属性 conn.setRequestProperty(accept, */*); conn.setRequestProperty(connection, Keep-Alive); conn.setRequestProperty(user-agent, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1); conn.setRequestProperty(Content-Type, application/x-www-form-urlencoded); conn.connect(); / 获取URLConnection对象对应的输出流 out = new OutputStreamWriter(conn.getOutputStream(), UTF-8); / 发送请求参数 if (pa