快递物流评价接口API文档附demo.docx
- 文档编号:7828338
- 上传时间:2023-01-26
- 格式:DOCX
- 页数:17
- 大小:19.19KB
快递物流评价接口API文档附demo.docx
《快递物流评价接口API文档附demo.docx》由会员分享,可在线阅读,更多相关《快递物流评价接口API文档附demo.docx(17页珍藏版)》请在冰豆网上搜索。
快递物流评价接口API文档附demo
快递物流评价接口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.请求系统级参数说明
参数名称
类型
说明
必须要求
RequestData
String
请求内容需进行URL(utf-8)编码。
请求内容JSON格式,须和DataType一致。
R
EBusinessID
String
电商ID。
R
RequestType
String
请求指令类型:
1011
R
DataSign
String
数据内容签名
R
DataType
String
请求、返回数据类型:
2-json;
O
3.应用级参数
参数名称
类型
说明
必须要求
MemberID
String
会员ID
O
EvaluateType
Int
评价类型(1-物流评价2-物流投诉)
R
ExpressNode
Int
物流环节(1-揽件2-派件)
R
OrderCode
String
订单编号
O
LogisticCode
String
物流单号
R
Target
ExpCode
String
快递公司编码
R
OutletCode
String
网点编码
O
CourierCode
String
快递员编码
O
Score
ExpValue
Double
快递公司分值
C
OutletValue
Double
快递网点分值
C
CourierValue
Double
快递员分值
C
EvaluationTag
String
评价标签
O
Contents
String
内容
C
备注:
R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
4.返回参数定义
参数名称
类型
说明
必须要求
EBusinessID
String
电商用户ID
R
Success
Bool
成功与否:
true,false
R
Reason
String
失败原因
O
5.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.请求系统级参数说明
参数名称
类型
说明
必须要求
RequestData
String
请求内容,JSON,须和DataType一致。
R
EBusinessID
String
电商ID。
R
RequestType
String
请求指令类型:
1012
R
DataSign
String
数据内容签名
R
DataType
String
请求、返回数据类型:
2-json;
R
3.应用级参数
参数名称
类型
说明
必须要求
MemberID
String
会员ID
O
LogisticsType
Int
获取类型(1-物流公司2-快递网点3-快递员)
R
ExpCode
Int
快递公司编码
O
OrderCode
String
网点编码
O
备注:
R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
4.返回参数定义
参数名称
类型
说明
必须要求
EBusinessID
String
电商用户ID
R
Success
Bool
成功与否:
true,false
R
Scores
ExpCode
String
快递公司编码
O
ExpValue
Double
快递公司分值
O
Reason
String
失败原因
O
5.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语言
php
//电商ID
defined('EBusinessID')ordefine('EBusinessID','请申请');
//电商加密私钥,注意保管,不要泄漏
defined('AppKey')ordefine('AppKey','请申请');
//请求url
//测试地址
defined('ReqURL')ordefine('ReqURL','http:
//testapi.kdniao.cc:
8081/Ebusiness/EbusinessOrderHandle.aspx');
//正式地址
//defined('ReqURL')ordefine('ReqURL','http:
//api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx');
//调用获取
//-------------------------------------------------------------
$logisticResult=getExpEvaluateByJson();
echo$logisticResult;
//-------------------------------------------------------------
/**
*Json方式物流评价投诉
*/
functiongetExpEvaluateByJson()
{
$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':
''}";
$datas=array(
'EBusinessID'=>EBusinessID,
'RequestType'=>'1011',
'RequestData'=>urlencode($requestData),
'DataType'=>'2',
);
$datas['DataSign']=encrypt($requestData,AppKey);
$result=sendPost(ReqURL,$datas);
//根据公司业务处理返回的信息......
return$result;
}
/**
*Json方式物流平均分获取
*/
functiongetExpAverageByJson()
{
$requestData='{"MemberID":
"123456","LogisticsType":
1,"ExpCode":
"","OutletCode":
""}';
$datas=array(
'EBusinessID'=>EBusinessID,
'RequestType'=>'1012',
'RequestData'=>urlencode($requestData),
'DataType'=>'2',
);
$datas['DataSign']=encrypt($requestData,AppKey);
$result=sendPost(ReqURL,$datas);
//根据公司业务处理返回的信息......
return$result;
}
/**
*post提交数据
*@paramstring$url请求Url
*@paramarray$datas提交的数据
*@returnurl响应返回的html
*/
functionsendPost($url,$datas){
$temps=array();
foreach($datasas$key=>$value){
$temps[]=sprintf('%s=%s',$key,$value);
}
$post_data=implode('&',$temps);
$url_info=parse_url($url);
if(empty($url_info['port']))
{
$url_info['port']=80;
}
$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签名生成
*@paramdata内容
*@paramappkeyAppkey
*@returnDataSign签名
*/
functionencrypt($data,$appkey){
returnurlencode(base64_encode(md5($data.$appkey)));
}
?
>
2..NET语言
usingSystem;
usingSystem.Collections.Generic;
usingSystem.Linq;
usingSystem.Text;
usingSystem.Web;
usingSystem.Net;
usingSystem.IO;
namespaceKdGoldAPI
{
publicclassKdApiSearchDemo
{
//电商ID
privatestringEBusinessID="请申请";
//电商加密私钥,注意保管,不要泄漏
privatestringAppKey="请申请";
//请求url
//测试环境
privatestringReqURL="http:
//testapi.kdniao.cc:
8081/Ebusiness/EbusinessOrderHandle.aspx";
//正式环境
//privatestringReqURL="http:
//api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx";
///
///Json方式物流评价投诉
///
///
publicstringgetExpEvaluateByJson()
{
stringrequestData="{'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.Add("RequestData",HttpUtility.UrlEncode(requestData,Encoding.UTF8));
param.Add("EBusinessID",EBusinessID);
param.Add("RequestType","1011");
stringdataSign=encrypt(requestData,AppKey,"UTF-8");
param.Add("DataSign",HttpUtility.UrlEncode(dataSign,Encoding.UTF8));
param.Add("DataType","2");
stringresult=sendPost(ReqURL,param);
//根据公司业务处理返回的信息......
returnresult;
}
///
///Json方式物流平均分获取
///
///
publicstringgetExpAverageByJson()
{
stringrequestData='{"MemberID":
"123456","LogisticsType":
1,"ExpCode":
"","OutletCode":
""}';
Dictionary
param.Add("RequestData",HttpUtility.UrlEncode(requestData,Encoding.UTF8));
param.Add("EBusinessID",EBusinessID);
param.Add("RequestType","1012");
stringdataSign=encrypt(requestData,AppKey,"UTF-8");
param.Add("DataSign",HttpUtility.UrlEncode(dataSign,Encoding.UTF8));
param.Add("DataType","2");
stringresult=sendPost(ReqURL,param);
//根据公司业务处理返回的信息......
returnresult;
}
///
///Post方式提交数据,返回网页的源代码
///
///
///
///
privatestringsendPost(stringurl,Dictionary
{
stringresult="";
StringBuilderpostData=newStringBuilder();
if(param!
=null&¶m.Count>0)
{
foreach(varpinparam)
{
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
{
HttpWebRequestrequest=(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;MSIE6.0;WindowsNT5.1;SV1;.NETCLR2.0.50727;.NETCLR3.0.04506.648;.NETCLR3.0.4506.2152;.NETCLR3.5.30729)";
request.Method="POST";
request.ContentLength=byteData.Length;
Streamstream=request.GetRequestStream();
stream.Write(byteData,0,byteData.Length);
stream.Flush();
stream.Close();
HttpWebResponseresponse=(HttpWebResponse)request.GetResponse();
StreambackStream=response.GetResponseStream();
StreamReadersr=newStreamReader(backStream,Encoding.GetEncoding("UTF-8"));
result=sr.ReadToEnd();
sr.Close();
backStream.Close();
response.Close();
request.Abort();
}
catch(Exceptionex)
{
result=ex.Message;
}
returnresult;
}
///
///电商Sign签名
///
///
///
///
///
privatestringencrypt(St
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 快递 物流 评价 接口 API 文档 demo