Shulou(Shulou.com)06/03 Report--

Express query API interface is to use the logistics order number to query logistics information. Mainly used in e-commerce mall, ERP system business, WMS system business, express cabinets, banks and other enterprises. A number of express logistics companies interface unified access, it is recommended that docking interface providers, one-time access to multiple express delivery, in the later technical maintenance will also save a lot of work.

At present, there are two ways to implement the express query API interface, one is active query, the other is subscribing interface to push data. Take the express bird interface as an example (interface docking requires the interface secret key, which is used for testing and cannot be used formally. You can apply for http://www.kdniao.com/ at the express bird official website, which is free to apply for the secret key.) finally, the demo with two methods is attached.

one。 Active query (instant query API)

1) Interface rules

A. The query API supports querying by waybill number (a single query with no more than 10 / S concurrency).

B, the designated logistics waybill number selects the corresponding express company code, the format is incorrect or the coding error will return the failure information. If Zhongtong Express Logistics order number should choose Express Company Code (ZTO)

C. The returned logistics tracking information is arranged in ascending order according to the time of occurrence.

D, interface instruction 1002.

E, request address: express bird

2) system-level and application-level input parameters

System-level input parameters

Types

Application-level input parameters

Must be required

Description

RequestData

String

OrderCode

O

Order number

Request content, JSON format, consistent with DataType

ShipperCode

R

Express company code

LogisticCode

R

Logistics order number

EBusinessID

String

R

E-commerce ID

RequestType

String

R

Request instruction type: 1002

DataSign

String

R

Data content signature

DataType

String

R

Request and return data type: 2-json

3) return result parameters

Parameter name

Types

Must be required

Description

EBusinessID

String

R

E-commerce user ID

OrderCode

String

O

Order number

ShipperCode

String

R

Express company code

LogisticCode

String

R

Logistics waybill number

CallBack

String

O

User identification

Success

Bool

R

Success or not

Reason

String

O

Cause of failure

State

String

R

Logistics status: 0-no track 2-on the way, 3-sign for receipt, 4-problem parts

Details of Traces/ Logistics track

AcceptTime

String

R

time

AcceptStation

String

R

Description

Remark

String

O

Remarks

4) JSON request example

{

"OrderCode":

"ShipperCode": "SF"

"LogisticCode": "1186 50888018"

}

/ / "SF" is the code of SF Express. Other codes can be downloaded from the official website of Express Bird.

5) JSON return example

/ / those with no logistics track

{

"EBusinessID": "1109259"

"Traces": []

"OrderCode":

"ShipperCode": "SF"

"LogisticCode": "118461988807"

"Success": true

"Reason": null

}

/ / those with logistics trajectory

{

"EBusinessID": "1109259"

"OrderCode":

"ShipperCode": "SF"

"LogisticCode": "118461988807"

"Success": true

"CallBack":

"State": 3

"Reason": null

"Traces": [

{

"AcceptTime": "08:05:37 on 2014-06-25"

"AcceptStation": "delivery is in progress. (sender: Deng Yufu, Tel: 1871 8866310) [Shenzhen City]"

"Remark": null

}

{

"AcceptTime": "04:01:28 on 2014-06-25"

"AcceptStation": "the express is in the Shenzhen distribution center, ready to be sent to the next station, Shenzhen [Shenzhen]"

"Remark": null

}

{

"AcceptTime": "2014 Universe 06 swap 2501 purl 41purl 06"

"AcceptStation": "Express delivery in Shenzhen Distribution Center [Shenzhen]"

"Remark": null

}

{

"AcceptTime": "20:18:58 on 2014-06-24"

"AcceptStation": "received [Shenzhen]"

"Remark": null

}

{

"AcceptTime": "20:55:28 on 2014-06-24"

"AcceptStation": "the express is in Shenzhen, ready to be sent to the next station, Shenzhen Distribution Center [Shenzhen]"

"Remark": null

}

{

"AcceptTime": "10:23:03 on 2014-06-25"

"AcceptStation": "delivery has been signed for [Shenzhen]"

"Remark": null

}

{

"AcceptTime": "10:23:03 on 2014-06-25"

"AcceptStation": "signed by: signed for [Shenzhen]"

"Remark": null

}

]

}

two。 Subscribe API push data (Logistics tracking API)

The subscription query interface is a customized service, and users can subscribe the order information to the express company. After updating the track, the express company will convert it into a standard interface form in real time and push it to the user, which can play the role of real-time push and improve efficiency.

At the same time, the data subscribed by users can also choose whether to inform the courier to come to the door to realize the function of placing orders online. In addition, express birds have other interface solutions such as on-the-way monitoring and electronic orders, which can be selected according to the needs of the company.

1) Interface rules

A. The information received by the order (distributed to the network, the information of the salesman) will be pushed to the customer through the push interface (subscribing no more than 30 / S). The customer needs to implement the interface as required.

B. Only Json format is supported.

C. Request instruction 1008.

D. Test interface address: http://testapi.kdniao.cc:8081/api/dist

E. After the joint transfer is passed, please change it to the official address: http://api.kdniao.cc/api/dist

F. Distribution and subscription APIs require the client to implement the callback API, callback RequestType (1008)

2) system-level and application-level parameters

System-level input parameters

Application-level input parameters

Types

Is it necessary

Description

RequestData (required parameters, request content, JSON format, must be consistent with DataType))

CallBack

String

O

User-defined callback information

MemberID

String

O

Membership ID (alternate field)

WareHouseID

String

O

Warehouse identity (alternate field)

CustomerName

String

O

Electronic face order customer account number

(apply with express outlets)

CustomerPwd

String

O

Electronic face single password

SendSite

String

O

Pick-up network identification

ShipperCode

String

R

Express company code

LogisticCode

String

R

courier number

OrderCode

String

O

Order number

MonthCode

String

O

Monthly knot coding

PayType

Int

O

Postage payment method:

1-cash, 2-pay, 3-month settlement, 4-third party payment

ExpType

String

O

Type of express delivery: 1-standard express

Cost

Double

O

Delivery fee (freight)

OtherCost

Double

O

Other expenses

Receiver

Company

String

O

Recipient company

Name

String

O

Recipient

Tel

String

O

Telephone

Mobile

String

O

Mobile phone

PostCode

String

O

Recipient zip code

ProvinceName

String

O

Pickup province (such as Guangdong Province, do not lack of "province")

CityName

String

O

Inbox market (such as Shenzhen, do not lack of "city")

ExpAreaName

String

O

Receiving area (such as Futian District, do not lack "district" or "county")

Address

String

O

Recipient's detailed address

Sender

Company

String

O

Sender's company

Name

String

O

Sender

Tel

String

O

Sender phone number

Mobile

String

O

Sender's mobile phone

PostCode

String

O

Sender zip code

ProvinceName

String

O

Sending province (such as Guangdong Province, do not lack "province")

CityName

String

O

Sending city (such as Shenzhen, do not lack "city")

ExpAreaName

String

O

Sending area (such as Futian District, do not lack "district" or "county")

Address

String

O

Detailed address of the sender

StartDate

String

O

Door-to-door pick-up time period:

"yyyy-MM-dd HH:mm:ss" format, the same format for all times in this article

EndDate

String

O

Weight

Double

O

Total weight of goods kg

Quantity

Int

O

Number of pieces / packages

Volume

Double

O

Total volume of goods m 3

Remark

String

O

Remarks

IsNotice

Int

O

Whether to distribute to the express delivery company: 1-no distribution; 0-distribution. Default is 0

IsSendMessage

Int

O

Whether to subscribe to SMS or not

0-do not need; 1-need

AddService

Name

String

0

Name of value-added service

Value

String

0

Value-added service value

CustomerID

String

0

Customer ID (optional)

Commodity

GoodsName

String

O

Product Name

GoodsCode

String

O

Commodity code

Goodsquantity

Int

O

Number of pieces

GoodsPrice

Double

O

Commodity price

GoodsWeight

Double

O

Commodity weight kg

GoodsDesc

String

O

Commodity description

GoodsVol

Double

O

Commodity volume m ~ 3

EBusinessID

String

R

Merchant ID

RequestType

String

R

Request instruction type: 1008

DataSign

String

R

Data content signature

DataType

String

R

Request and return data type: 2-json

3) return result parameters

Synchronous return

Parameter name

Types

Must be required

Description

EBusinessID

String

R

E-commerce user ID

UpdateTime

String

R

time

Success

Bool

R

Success or failure: true,false

Reason

String

O

Cause of failure

EstimatedDeliveryTime

String

O

Estimated arrival time of the order yyyy-mm-dd

4) JSON request example

{

"ShipperCode": "SF"

"OrderCode": "SF201608081055208281"

"LogisticCode": "3100707578976"

"PayType": "1"

"ExpType": "1"

"CustomerName":

"CustomerPwd":

"MonthCode":

"IsNotice": "0"

"Sender": {

"Name": "1255760"

"Tel":

"Mobile": "13700000000"

"ProvinceName": "Guangdong"

"CityName": "Shenzhen

"ExpAreaName": "Futian District"

"Address": "Test address"

}

"Receiver": {

"Name": "1255760"

"Tel":

"Mobile": "13800000000"

"ProvinceName": "Guangdong"

"CityName": "Shenzhen

"ExpAreaName": "Longhua New area"

"Address": "Test address 2"

}

"Commodity": [

{

"GoodsName": "Book"

}

]

}

5) JSON return example

{

"EBusinessID": "1151847"

"UpdateTime": "2016-08-0916 purl 4238"

"Success": true

"Reason":

"EstimatedDeliveryTime": "2016-8-12"

}

Real-time query APIdemo

Import java.io.BufferedReader

Import java.io.IOException

Import java.io.InputStreamReader

Import java.io.OutputStreamWriter

Import java.io.UnsupportedEncodingException

Import java.net.HttpURLConnection

Import java.net.URL

Import java.net.URLEncoder

Import java.security.MessageDigest

Import java.util.HashMap

Import java.util.Map

/ *

The e-commerce ID and private key in the express bird logistics track real-time query interface DEMO can only be used for testing. In the formal environment, please register a separate account with more than 500 single queries per day. It is recommended to connect to our logistics track subscription push interface ID and Key. Please apply to the official website: http://www.kdniao.com/ServiceApply.aspx

, /

Public class KdniaoTrackQueryAPI {

/ / DEMOpublic static void main (String [] args) {KdniaoTrackQueryAPI api = new KdniaoTrackQueryAPI (); try {String result = api.getOrderTracesByJson ("ANE", "210001633605"); System.out.print (result);} catch (Exception e) {e.printStackTrace ();}} / / E-commerce IDprivate String EBusinessID= "Please apply for http://www.kdniao.com/ServiceApply.aspx"; at the official express bird website. / / E-commerce encrypted private key, provided by express bird, be careful to keep it, do not disclose private String AppKey= "Please apply for http://www.kdniao.com/ServiceApply.aspx";// request urlprivate String ReqURL=" http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx"; on the official website of express bird. / * Json query order logistics track * @ throws Exception * / public String getOrderTracesByJson (String expCode, String expNo) throws Exception {String requestData= "{'OrderCode':'','ShipperCode':'" + expCode + "', 'LogisticCode':'" + expNo + "'}"; Map params = new HashMap (); params.put ("RequestData", urlEncoder (requestData, "UTF-8"); params.put ("EBusinessID", EBusinessID) Params.put ("RequestType", "1002"); String dataSign=encrypt (requestData, AppKey, "UTF-8"); params.put ("DataSign", urlEncoder (dataSign, "UTF-8"); params.put ("DataType", "2"); String result=sendPost (ReqURL, params); / / information returned according to the company's business processing. Return result;} / * MD5 encryption * @ param str content * @ param charset Encoding * @ 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 = result[i] & 0xff; if (val 0){ param.append("&"); } param.append(entry.getKey()); param.append("="); param.append(entry.getValue()); //System.out.println(entry.getKey()+":"+entry.getValue()); } //System.out.println("param:"+param.toString()); out.write(param.toString()); } // flush输出流的缓冲 out.flush(); // 定义BufferedReader输入流来读取URL的响应 in = new BufferedReader( new InputStreamReader(conn.getInputStream(), "UTF-8")); String line; while ((line = in.readLine()) != null) { result.append(line); } } catch (Exception e) { e.printStackTrace(); } //使用finally块来关闭输出流、输入流 finally{ try{ if(out!=null){ out.close(); } if(in!=null){ in.close(); } } catch(IOException ex){ ex.printStackTrace(); } } return result.toString();}private static char[] base64EncodeChars = new char[] { 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/' }; public static String base64Encode(byte[] data) { StringBuffer sb = new StringBuffer(); int len = data.length; int i = 0; int b1, b2, b3; while (i < len) { b1 = data[i++] & 0xff; if (i == len) { sb.append(base64EncodeChars[b1 >

> > 2]); sb.append (base64EncodeChars [(b1 & 0x3) > > 2]); sb.append (base64EncodeChars [(b1 & 0x03) > 4)]); sb.append (base64EncodeChars [(b2 & 0x0f) > > 2]); sb.append (base64EncodeChars [(b1 & 0x03) > > 4)]; sb.append (base64EncodeChars [(b2 & 0x0f) > > 6)]) Sb.append (Base64EncodeCharts [b3 & 0x3f]);} return sb.toString ();}

}

Logistics tracking APIdemo

Import java.io.BufferedReader

Import java.io.IOException

Import java.io.InputStreamReader

Import java.io.OutputStreamWriter

Import java.io.UnsupportedEncodingException

Import java.net.HttpURLConnection

Import java.net.URL

Import java.net.URLEncoder

Import java.util.HashMap

Import java.util.Map

Import java.security.MessageDigest

/ *

Express bird subscription push 2.0 interface ID and Key please apply to the official website: http://www.kdniao.com/ServiceApply.aspx

, /

Public class KdniaoSubscribeAPI {

/ / DEMOpublic static void main (String [] args) {KdniaoSubscribeAPI api = new KdniaoSubscribeAPI (); try {String result = api.orderTracesSubByJson (); System.out.print (result);} catch (Exception e) {e.printStackTrace ();}} / / E-commerce IDprivate String EBusinessID= "Please go to the express bird website to apply for http://www.kdniao.com/ServiceApply.aspx";" / / E-commerce encrypted private key, provided by express bird, be careful to keep it, do not disclose private String AppKey=. "Please apply for http://www.kdniao.com/ServiceApply.aspx";// test request urlprivate String ReqURL =" http://testapi.kdniao.cc:8081/api/dist";// official request url//private String ReqURL = "http://api.kdniao.cc/api/dist";" on the official website of express bird. / * * Json logistics information subscription * @ throws Exception * / public String orderTracesSubByJson () throws Exception {String requestData= "{'OrderCode':' SF201608081055208281'," + "'ShipperCode':'SF'," + "' LogisticCode':'3100707578976'," + "'PayType':1" "+" 'ExpType':1, "" + "' CustomerName':''," + "'CustomerPwd':''," + "' MonthCode':''," + "'IsNotice':0" "+" 'Cost':1.0, "" + "' OtherCost':1.0," + "'Sender':" + "{" + "' Company':'LV','Name':'Taylor','Mobile':'15018442396' 'ProvinceName':' Shanghai', 'CityName':' Shanghai', 'ExpAreaName':' Qingpu District','73 Address':' Pearl Road'}, "+" 'Receiver': "+" {"+"' Company':'GCCUI','Name':'Yann','Mobile':'15018442396','ProvinceName':' Beijing' 'CityName':' Beijing', 'ExpAreaName':' Chaoyang District', 'Yaxiu Building, Sanlitun Street, Address':''}, "+" 'Commodity': "+" [{"+"' GoodsName':' shoes', 'Goodsquantity':1,'GoodsWeight':1.0}] "+" 'Weight':1.0, "" + "' Quantity':1,"+" 'Volume':0.0, "" + "' Remark':' handle carefully'}" Map params = new HashMap (); params.put ("RequestData", urlEncoder (requestData, "UTF-8"); params.put ("EBusinessID", EBusinessID); params.put ("RequestType", "1008"); String dataSign=encrypt (requestData, AppKey, "UTF-8"); params.put ("DataSign", urlEncoder (dataSign, "UTF-8"); params.put ("DataType", "2"); String result=sendPost (ReqURL, params) / / the information returned according to the company's business processing. Return result;} / * MD5 encryption * @ param str content * @ param charset Encoding * @ 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 = result[i] & 0xff; if (val 0){ param.append("&"); } param.append(entry.getKey()); param.append("="); param.append(entry.getValue()); System.out.println(entry.getKey()+":"+entry.getValue()); } System.out.println("param:"+param.toString()); out.write(param.toString()); } // flush输出流的缓冲 out.flush(); // 定义BufferedReader输入流来读取URL的响应 in = new BufferedReader( new InputStreamReader(conn.getInputStream(), "UTF-8")); String line; while ((line = in.readLine()) != null) { result.append(line); } } catch (Exception e) { e.printStackTrace(); } //使用finally块来关闭输出流、输入流 finally{ try{ if(out!=null){ out.close(); } if(in!=null){ in.close(); } } catch(IOException ex){ ex.printStackTrace(); } } return result.toString();}private static char[] base64EncodeChars = new char[] { 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/' }; public static String base64Encode(byte[] data) { StringBuffer sb = new StringBuffer(); int len = data.length; int i = 0; int b1, b2, b3; while (i < len) { b1 = data[i++] & 0xff; if (i == len) { sb.append(base64EncodeChars[b1 >

> > 2]); sb.append (base64EncodeChars [(b1 & 0x3) > > 2]); sb.append (base64EncodeChars [(b1 & 0x03) > 4)]); sb.append (base64EncodeChars [(b2 & 0x0f) > > 2]); sb.append (base64EncodeChars [(b1 & 0x03) > > 4)]; sb.append (base64EncodeChars [(b2 & 0x0f) > > 6)]) Sb.append (Base64EncodeCharts [b3 & 0x3f]);} return sb.toString ();}

}

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.