基于PHP的对接电子面单接口平台案例

电子面单接口目前有三种对接方式，快递电子面单接口、菜鸟电子面单接口和快递鸟电子面单接口。这三种接口各有特点。

一.电子面单接口定义

1. 快递电子面单接口：快递公司自己开发的电子面单服务， 商家使用必须快递公司上门做系统对接，使用一家快递则需要对接一次。

2.菜鸟电子面单接口：可一次对接15家快递公司， 无需和每一家快递公司做对接。支持快递有四通一达、EMS、宅急送、德邦、优速、天天、快捷、全峰等15家常用快递公司，其中不包括顺丰。

3.快递鸟电子面单接口：可一次对接15家快递公司， 无需和每一家快递公司做对接。支持快递有四通一达、顺丰、EMS、宅急送、德邦、优速等15家快递公司，对顺丰有电子面单服务需求的可以选择顺丰自有的电子面单或者是快递鸟电子面单。

 

二.开通使用流程

1.快递电子面单

a. 和多家快递公司申请账号

b.分别进行接口对接

c.电子面单服务用户向快递网点申请开通及确认合作细节

2.菜鸟电子面单

a.向菜鸟提交对接申请

b.和菜鸟进行接口对接

c.电子面单服务用户向菜鸟申请账号

d.电子面单服务用户向快递网点申请开通及确认合作细节

3.快递鸟电子面单

a. 进入http://www.kdniao.com/reg申请账号，获取专属的ID和KEY

b.和快递鸟进行接口对接

c.电子面单服务用户向快递网点申请开通及确认合作细节

接口类型较多，以下先附上快递鸟电子面单接口调用方式，希望对大家有所帮助。后面将逐个对菜鸟电子面单、顺丰电子面单等接口调用方式做整理说明。

三.电子面单对接案例—快递鸟

1.接口描述

接口支持的消息接收方式：HTTP POST

请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8"

API地址：http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx

2.请求系统级参数

参数名称	类型	说明	必须要求
RequestData	String	请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。	R
EBusinessID	String	商户ID，请在我的服务页面查看。	R
RequestType	String	请求指令类型：1007	R
DataSign	String	数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后进行URL(utf-8)编码。详细过程请查看Demo。	R
DataType	String	请求、返回数据类型：只支持JSON格式	O

备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）。

3.接口参数

请求内容字段定义

参数名称	类型	说明	是否必须
CallBack	String	用户自定义回调信息	O
MemberID	String	会员标识	O
CustomerName	String	电子面单客户账号（与快递网点申请）	O
CustomerPwd	String	电子面单密码	O
SendSite	String	收件网点标识	O
ShipperCode	String	快递公司编码	R
LogisticCode	String	快递单号	O
OrderCode	String	订单编号	R
MonthCode	String	月结编码	C
PayType	Int	邮费支付方式:1-现付，2-到付，3-月结，4-第三方支付	R
ExpType	String	快递类型：1-标准快件	R
IsNotice	Int	是否通知快递员上门揽件：0-不通知；1-通知；不填则默认为1	O
Cost	Double	寄件费（运费）	O
OtherCost	Double	其他费用	O
Receiver	Company	String	收件人公司	O
Name	String	收件人	R
Tel	String	电话与手机，必填一个	R
Mobile	String
PostCode	String	收件人邮编	O
ProvinceName	String	收件省（如广东省，不要缺少“省”）	R
CityName	String	收件市（如深圳市，不要缺少“市”）	R
ExpAreaName	String	收件区（如福田区，不要缺少“区”或“县”）	O
Address	String	收件人详细地址	R
Sender	Company	String	发件人公司	O
Name	String	发件人	R
Tel	String	电话与手机，必填一个	R
Mobile	String
PostCode	String	发件人邮编	O
ProvinceName	String	发件省（如广东省，不要缺少“省”）	R
CityName	String	发件市（如深圳市，不要缺少“市”）	R
ExpAreaName	String	发件区（如福田区，不要缺少“区”或“县”）	O
Address	String	发件人详细地址	R
StartDate	String	上门取货时间段:"yyyy-MM-dd HH:mm:ss"格式化，本文中所有时间格式相同	O
EndDate	String	O
Weight	Double	物品总重量kg	O
Quantity	Int	件数/包裹数	O
Volume	Double	物品总体积m3	O
Remark	String	备注	O
AddServices
AddService	Name	String	增值服务名称	O
Value	String	增值服务值	O
CustomerID	String	客户标识（选填）	O
Commoditys
Commodity	GoodsName	String	商品名称	R
GoodsCode	String	商品编码	O
Goodsquantity	Int	商品数量	O
GoodsPrice	Double	商品价格	O
GoodsWeight	Double	商品重量kg	O
GoodsDesc	String	商品描述	O
GoodsVol	Double	商品体积m3	O
IsReturnPrintTemplate	String	返回电子面单模板：0-不需要；1-需要	O

返回参数定义

参数名称	类型	说明	必须要求
EBusinessID	String	用户ID	R
Order	OrderCode	String	订单编号	R
ShipperCode	String	快递公司编码	R
LogisticCode	String	快递单号	R
MarkDestination	String	大头笔	O
OriginCode	String	始发地区域编码	O
OriginName	String	始发地/始发网点	O
DestinatioCode	String	目的地区域编码	O
DestinatioName	String	目的地/到达网点	O
SortingCode	String	分拣编码	O
PackageCode	String	集包编码	O
Success	Bool	成功与否	R
ResultCode	String	错误编码	R
Reason	String	失败原因	O
UniquerRequestNumber	String	唯一标识	R
PrintTemplate	String	面单打印模板	O
EstimatedDeliveryTime	String	订单预计到货时间yyyy-mm-dd	O
Callback	String	用户自定义回调信息	O

4.PHP对接源码

<?php

//电商ID
defined('EBusinessID') or define('EBusinessID', '请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx');
//电商加密私钥，快递鸟提供，注意保管，不要泄漏
defined('AppKey') or define('AppKey', '请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx');
//请求url，接口正式地址：http://api.kdniao.cc/api/Eorderservice
defined('ReqURL') or define('ReqURL', 'http://testapi.kdniao.cc:8081/api/Eorderservice');

//调用获取物流轨迹
//-------------------------------------------------------------

//构造电子面单提交信息
$eorder = [];
$eorder["ShipperCode"] = "SF";
$eorder["OrderCode"] = "PM201604062341";
$eorder["PayType"] = 1;
$eorder["ExpType"] = 1;

$sender = [];
$sender["Name"] = "李先生";
$sender["Mobile"] = "18888888888";
$sender["ProvinceName"] = "李先生";
$sender["CityName"] = "深圳市";
$sender["ExpAreaName"] = "福田区";
$sender["Address"] = "赛格广场5401AB";

$receiver = [];
$receiver["Name"] = "李先生";
$receiver["Mobile"] = "18888888888";
$receiver["ProvinceName"] = "李先生";
$receiver["CityName"] = "深圳市";
$receiver["ExpAreaName"] = "福田区";
$receiver["Address"] = "赛格广场5401AB";

$commodityOne = [];
$commodityOne["GoodsName"] = "其他";
$commodity = [];
$commodity[] = $commodityOne;

$eorder["Sender"] = $sender;
$eorder["Receiver"] = $receiver;
$eorder["Commodity"] = $commodity;

//调用电子面单
$jsonParam = json_encode($eorder, JSON_UNESCAPED_UNICODE);

//$jsonParam = JSON($eorder);//兼容php5.2（含）以下

echo "电子面单接口提交内容：<br/>".$jsonParam;
$jsonResult = submitEOrder($jsonParam);
echo "<br/><br/>电子面单提交结果:<br/>".$jsonResult;

//解析电子面单返回结果
$result = json_decode($jsonResult, true);
echo "<br/><br/>返回码:".$result["ResultCode"];
if($result["ResultCode"] == "100") {
	echo "<br/>是否成功:".$result["Success"];
}
else {
	echo "<br/>电子面单下单失败";
}
//-------------------------------------------------------------

/**
 * Json方式 查询订单物流轨迹
 */
function submitEOrder($requestData){
	$datas = array(
        'EBusinessID' => EBusinessID,
        'RequestType' => '1007',
        'RequestData' => urlencode($requestData) ,
        'DataType' => '2',
    );
    $datas['DataSign'] = encrypt($requestData, AppKey);
	$result=sendPost(ReqURL, $datas);

	//根据公司业务处理返回的信息......

	return $result;
}

/**
 *  post提交数据
 * @param  string $url 请求Url
 * @param  array $datas 提交的数据
 * @return url响应返回的html
 */
function sendPost($url, $datas) {
    $temps = array();
    foreach ($datas as $key => $value) {
        $temps[] = sprintf('%s=%s', $key, $value);
    }
    $post_data = implode('&', $temps);
    $url_info = parse_url($url);
	if($url_info['port']=='')
	{
		$url_info['port']=80;
	}
	echo $url_info['port'];
    $httpheader = "POST " . $url_info['path'] . " HTTP/1.0\r\n";
    $httpheader.= "Host:" . $url_info['host'] . "\r\n";
    $httpheader.= "Content-Type:application/x-www-form-urlencoded\r\n";
    $httpheader.= "Content-Length:" . strlen($post_data) . "\r\n";
    $httpheader.= "Connection:close\r\n\r\n";
    $httpheader.= $post_data;
    $fd = fsockopen($url_info['host'], $url_info['port']);
    fwrite($fd, $httpheader);
    $gets = "";
	$headerFlag = true;
	while (!feof($fd)) {
		if (($header = @fgets($fd)) && ($header == "\r\n" || $header == "\n")) {
			break;
		}
	}
    while (!feof($fd)) {
		$gets.= fread($fd, 128);
    }
    fclose($fd);

    return $gets;
}

/**
 * 电商Sign签名生成
 * @param data 内容
 * @param appkey Appkey
 * @return DataSign签名
 */
function encrypt($data, $appkey) {
    return urlencode(base64_encode(md5($data.$appkey)));
}
/**************************************************************
 *
 *  使用特定function对数组中所有元素做处理
 *  @param  string  &$array     要处理的字符串
 *  @param  string  $function   要执行的函数
 *  @return boolean $apply_to_keys_also     是否也应用到key上
 *  @access public
 *
 *************************************************************/
function arrayRecursive(&$array, $function, $apply_to_keys_also = false)
{
    static $recursive_counter = 0;
    if (++$recursive_counter > 1000) {
        die('possible deep recursion attack');
    }
    foreach ($array as $key => $value) {
        if (is_array($value)) {
            arrayRecursive($array[$key], $function, $apply_to_keys_also);
        } else {
            $array[$key] = $function($value);
        }

        if ($apply_to_keys_also && is_string($key)) {
            $new_key = $function($key);
            if ($new_key != $key) {
                $array[$new_key] = $array[$key];
                unset($array[$key]);
            }
        }
    }
    $recursive_counter--;
}

/**************************************************************
 *
 *  将数组转换为JSON字符串（兼容中文）
 *  @param  array   $array      要转换的数组
 *  @return string      转换得到的json字符串
 *  @access public
 *
 *************************************************************/
function JSON($array) {
    arrayRecursive($array, 'urlencode', true);
    $json = json_encode($array);
    return urldecode($json);
}
?>