快递物流评价接口API文档(附demo).doc

快递物流评价接口API文档（附demo）物流评价接口是面向电商、ERP系统商、仓储系统商等企业，提供评价物流，网点，快递员的渠道，并批量获取平均分的功能，平均分值可应用于快递公司推荐排序，综合选择，展示商家实力等场景。商家的评价分值将由接口汇总计算，统一传递到物流公司，指导物流公司提升服务质量。该接口由快递鸟提供，分为评价接口和评分获取接口。一、物流评价投诉接口1.接口描述/说明通过此接口可对快递公司、网点、快递员进行评价或投诉。（1）仅支持Json格式。（2）请求指令1011。（3）每次请求不超过100条明细。（4）测试接口地址：http:/testapi.kdniao.cc:8081/api/dist（5）联调通过后请更换为正式地址：http:/api.kdniao.cc/api/dist（6）需在快递鸟网站申请接口秘钥2.请求系统级参数说明参数名称类型说明必须要求RequestDataString请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。REBusinessIDString电商ID。RRequestTypeString请求指令类型：1011RDataSignString数据内容签名RDataTypeString请求、返回数据类型：2-json；O3.应用级参数参数名称类型说明必须要求MemberIDString会员IDOEvaluateTypeInt评价类型(1-物流评价2-物流投诉)RExpressNodeInt物流环节(1-揽件 2-派件)ROrderCodeString订单编号OLogisticCodeString物流单号RTargetExpCodeString快递公司编码ROutletCodeString网点编码OCourierCodeString快递员编码OScoreExpValueDouble快递公司分值COutletValueDouble快递网点分值CCourierValueDouble快递员分值CEvaluationTagString评价标签OContentsString内容C备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）4.返回参数定义参数名称类型说明必须要求EBusinessIDString电商用户IDRSuccessBool成功与否:true,falseRReasonString失败原因O5.JSON请求示请求示例 JSON MemberID:, EvaluateType:1, ExpressNode:1, OrderCode:, LogisticCode:12345678, Target: ExpCode:YTO, OutletCode:0453, CourierCode:2001158001 , Score: ExpValue:5, OutletValue:4.5, CourierValue:4 , EvaluationTag:速度快，服务好, Content: 6.JSON返回示例返回示例 JSON EBusinessID: 1261737, Success: true 二、物流平均分获取接口1.接口描述/说明通过此接口可以获取各个快递公司的评价平均分。（1）仅支持Json格式。（2）请求指令1012。（3）测试接口地址：http:/testapi.kdniao.cc:8081/api/dist（4）联调通过后请更换为正式地址：http:/api.kdniao.cc/api/dist（5）需申请秘钥2.请求系统级参数说明参数名称类型说明必须要求RequestDataString请求内容，JSON,须和DataType一致。REBusinessIDString电商ID。RRequestTypeString请求指令类型：1012RDataSignString数据内容签名RDataTypeString请求、返回数据类型：2-json；R3.应用级参数参数名称类型说明必须要求MemberIDString会员IDOLogisticsTypeInt获取类型（1-物流公司2-快递网点3-快递员）RExpCodeInt快递公司编码OOrderCodeString网点编码O备注：R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）4.返回参数定义参数名称类型说明必须要求EBusinessIDString电商用户IDRSuccessBool成功与否:true,falseRScoresExpCodeString快递公司编码OExpValueDouble快递公司分值OReasonString失败原因O5.JSON请求示例请求示例 JSON MemberID:123456, LogisticsType:1, ExpCode:, OutletCode: 6.JSON返回示例返回示例 JSON EBusinessID: 1261737, Success: true, Scores: ExpCode:EMS, ExpValue:4.3 , ExpCode:YTO, ExpValue:4.5 , ExpCode:SF, ExpValue:4.4 三、接口代码1.PHP语言 EBusinessID, RequestType = 1011, RequestData = urlencode($requestData) , DataType = 2, ); $datasDataSign = encrypt($requestData, AppKey);$result=sendPost(ReqURL, $datas);/根据公司业务处理返回的信息.return $result;/* * Json方式 物流平均分获取 */function getExpAverageByJson()$requestData=MemberID:123456,LogisticsType:1,ExpCode:,OutletCode:;$datas = array( EBusinessID = EBusinessID, RequestType = 1012, RequestData = urlencode($requestData) , DataType = 2, ); $datasDataSign = 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(empty($url_infoport)$url_infoport=80; $httpheader = POST . $url_infopath . HTTP/1.0rn; $httpheader.= Host: . $url_infohost . rn; $httpheader.= Content-Type:application/x-www-form-urlencodedrn; $httpheader.= Content-Length: . strlen($post_data) . rn; $httpheader.= Connection:closernrn; $httpheader.= $post_data; $fd = fsockopen($url_infohost, $url_infoport); fwrite($fd, $httpheader); $gets = ;$headerFlag = true;while (!feof($fd) if ($header = fgets($fd) & ($header = rn | $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);?2.NET语言using System;using System.Collections.Generic;using System.Linq;using System.Text;using System.Web;using System.Net;using System.IO; namespace KdGoldAPI public class KdApiSearchDemo /电商ID private string EBusinessID = 请申请; /电商加密私钥，注意保管，不要泄漏 private string AppKey = 请申请; /请求url /测试环境 private string ReqURL = http:/testapi.kdniao.cc:8081/Ebusiness/EbusinessOrderHandle.aspx; /正式环境 /private string ReqURL = http:/api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx; / / Json方式 物流评价投诉 / / public string getExpEvaluateByJson() string requestData = MemberID: , + EvaluateType:1, + ExpressNode:1, + OrderCode:, + LogisticCode:12345678, + Target: + + ExpCode:YTO,OutletCode:0453,CourierCode:200115887318, + Score: + + ExpValue:5,OutletValue:4.5,CourierValue:4, + EvaluationTag:速度快，服务好, + Content:; Dictionary param = new Dictionary(); param.Add(RequestData, HttpUtility.UrlEncode(requestData, Encoding.UTF8); param.Add(EBusinessID, EBusinessID); param.Add(RequestType, 1011); string dataSign = encrypt(requestData, AppKey, UTF-8); param.Add(DataSign, HttpUtility.UrlEncode(dataSign, Encoding.UTF8); param.Add(DataType, 2); string result = sendPost(ReqURL, param); /根据公司业务处理返回的信息. return result; / / Json方式 物流平均分获取 / / public string getExpAverageByJson() string requestData = MemberID:123456,LogisticsType:1,ExpCode:,OutletCode:; Dictionary param = new Dictionary(); param.Add(RequestData, HttpUtility.UrlEncode(requestData, Encoding.UTF8); param.Add(EBusinessID, EBusinessID); param.Add(RequestType, 1012); string dataSign = encrypt(requestData, AppKey, UTF-8); param.Add(DataSign, HttpUtility.UrlEncode(dataSign, Encoding.UTF8); param.Add(DataType, 2); string result = sendPost(ReqURL, param); /根据公司业务处理返回的信息. return result; / / Post方式提交数据，返回网页的源代码 / / 发送请求的 URL / 请求的参数集合 / 远程资源的响应结果 private string sendPost(string url, Dictionary param) string result = ; StringBuilder postData = new StringBuilder(); if (param != null & param.Count 0) foreach (var p in param) if (postData.Length 0) postData.Append(&); postData.Append(p.Key); postData.Append(=); postData.Append(p.Value); byte byteData = Encoding.GetEncoding(UTF-8).GetBytes(postData.ToString(); try HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url); request.ContentType = application/x-www-form-urlencoded; request.Referer = url; request.Accept = */*; request.Timeout = 30 * 1000; request.UserAgent = Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729); request.Method = POST; request.ContentLength = byteData.Length; Stream stream = request.GetRequestStream(); stream.Write(byteData, 0, byteData.Length); stream.Flush(); stream.Close(); HttpWebResponse response = (HttpWebResponse)request.GetResponse(); Stream backStream = response.GetResponseStream(); StreamReader sr = new StreamReader(backStream, Encoding.GetEncoding(UTF-8); result = sr.ReadToEnd(); sr.Close(); backStream.Close(); response.Close(); request.Abort(); catch (Exception ex) result = ex.Message; return result; / /电商Sign签名 / /内容 /Appkey /URL编码 /DataSign签名 private string encrypt(String content, String keyValue, String charset) if (keyValue != null) return base64(MD5(content + keyValue