為了方便網(wǎng)站快速接入，物流巴巴電商團(tuán)隊(duì)已將HTTP通訊請求(基于 Request Payload )封裝成獨(dú)立的SDK文件，您僅需引入SDK文件，并構(gòu)造簡單的請求參數(shù)，即可得到服務(wù)器返回的標(biāo)準(zhǔn) JavaScript 對象標(biāo)記 (JSON) 數(shù)據(jù)，而無需具備基本的HTTP協(xié)議知識(shí)背景，方便、簡單。
用戶通過指定API參數(shù)來獲取對應(yīng)的結(jié)果，物流巴巴海運(yùn)費(fèi)查詢的API參數(shù)集如下表所示：
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| key | string | 必填 | 用戶統(tǒng)一授權(quán)KEY，需在實(shí)例化sdk后，為對象指定key屬性 |
| type | string | 必填 | 請求海運(yùn)數(shù)據(jù)的類型：fcl整箱,lcl拼箱 |
| pol | string | 必填 | 起運(yùn)港口簡碼 |
| pod | string | 必填 | 目的港口簡碼 |
| per_page | int | 必填 | 每個(gè)頁面中希望展示的數(shù)量 |
| current_page | int | 必填 | 當(dāng)前數(shù)據(jù)分頁 |
下載SDK，并引入到您的項(xiàng)目文件中，示例代碼：
?<?php
/**
* API接口演示程序
* Auth: 物流巴巴
* Date: 2016/5/20
* Copyright 5688.com.cn
* Link:http:///ports 港口簡碼查詢
*/
require_once "class.awice.php";
$_api_key='你的KEY';
$api = new Awice();
$api->key = $_api_key;
$_result = $api->payLoad(
array(
'type' => 'fcl',
'pol' => 'CNSZN',
'pod' => 'AUSYD',
'per_page' => 10,
'current_page' => 1
)
);
//顯示結(jié)果
header('Content-type: application/json');
echo $_result;
請求發(fā)送后，服務(wù)器將返回標(biāo)準(zhǔn)JSON字符串：
請注意，所有的響應(yīng)都包含在JSON對象result根元素中，響應(yīng)對象中的 "status" 字段包含了請求的狀態(tài)，未出現(xiàn) 任何錯(cuò)誤時(shí)status的值為1，當(dāng)status值為1之外的值時(shí)，響應(yīng)對象中可能會(huì)包含一個(gè)附加的 err_msg 字段，此字段詳細(xì)地說明了給定狀態(tài)代碼背后的原因。
響應(yīng)字段說明，列表如下：
| 節(jié)點(diǎn) | 字段(屬性) | 說明 |
|---|---|---|
| / | status | 請求狀態(tài) 1：成功 0:失敗 |
| / | err_msg | status字段為1以外的值時(shí)，返回包含的錯(cuò)誤信息。 |
| /metaData | polCode、podCode、perPage、pageNow、pageCount、link | 起運(yùn)港簡碼、目的港簡碼、每頁顯示的數(shù)據(jù)數(shù)量、當(dāng)前第幾頁、總頁數(shù)、數(shù)據(jù)來源 |
| /recordSet | cls、etd、tt、stdate、enddate、oceanFreight[]、localCharges[] | 截關(guān)日，開船日，有效期（始），有效期（止），海運(yùn)費(fèi)(數(shù)組)，附加費(fèi)(數(shù)組) |
為保障系統(tǒng)穩(wěn)定，服務(wù)器原子性（atomicity）數(shù)據(jù)統(tǒng)計(jì)機(jī)制會(huì)精確統(tǒng)計(jì)用戶每一次請求行為，超出請求頻率后系統(tǒng)會(huì)自動(dòng)鎖定用戶請求60（S）,超出請求上限后，系統(tǒng)將返回錯(cuò)誤信息。
單位時(shí)間（天）內(nèi)，用戶請求上限：1000次；
單位時(shí)間（分）內(nèi)，最大用戶并發(fā)請求30次；
*此值可能會(huì)隨著用戶的實(shí)際需求適時(shí)做出相應(yīng)調(diào)整，以保障用戶的最大需求。
用戶使用此接口時(shí)，應(yīng)在醒目位置顯示JSON對象中l(wèi)ink字段所包含的數(shù)據(jù)來源信息。