為了方便網(wǎng)站快速接入，物流巴巴電商團(tuán)隊(duì)已將HTTP通訊請(qǐng)求(基于 Request Payload )并構(gòu)造簡(jiǎn)單的請(qǐng)求參數(shù)，即可得到服務(wù)器返回的標(biāo)準(zhǔn) JavaScript 對(duì)象標(biāo)記 (JSON) 數(shù)據(jù)，而無(wú)需具備基本的HTTP協(xié)議知識(shí)背景，方便、簡(jiǎn)單。
接口鏈接：https://scan.5688.com.cn/api/awice_api/getOceanData；POST傳參；物流巴巴海運(yùn)費(fèi)查詢(xún)的API參數(shù)集如下表所示：
| 屬性 | 類(lèi)型 | 約束 | 說(shuō)明 |
|---|---|---|---|
| key | string | 必填 | 用戶(hù)統(tǒng)一授權(quán)KEY，為對(duì)象指定key屬性，登錄后在A(yíng)PI管理/控制臺(tái)獲?。ㄐ枵J(rèn)證）點(diǎn)擊登錄 |
| type | string | 不必填（默認(rèn)fcl） | 請(qǐng)求海運(yùn)數(shù)據(jù)的類(lèi)型：fcl整箱,lcl拼箱 |
| pol | string | 必填 | 起運(yùn)港口中文或者英文 |
| pod | string | 不必填 | 目的港口中文或者英文 |
| shipowner | string | 不必填 | 船公司簡(jiǎn)碼 點(diǎn)擊查詢(xún) |
| limit | int | 不必填（默認(rèn)10） | 每個(gè)頁(yè)面中希望展示的數(shù)量 |
| page | int | 不必填（默認(rèn)1） | 當(dāng)前數(shù)據(jù)分頁(yè) |
示例代碼：
?<?php
/**
* API接口演示程序
* Auth: 物流巴巴
* Date: 2025/5/16
* Copyright 5688.cn
* Link:https://scan.5688.com.cn/api/awice_api/getOceanData 海運(yùn)數(shù)據(jù)查詢(xún)
*/
public function actionApi(){
$data = [
'key'=>'您的KEY',
'type'=>'fcl',
'pol'=>'深圳',
'pod'=>'曼谷',
'shipowner'=>'MSC',
'page'=>1,
'limit'=>10,
];
$client = new Client();
$response = $client->createRequest()
->setMethod('POST')
->setUrl('https://scan.5688.com.cn/api/awice_api/getOceanData')
->setData($data)
->setFormat(Client::FORMAT_JSON) //提交的數(shù)據(jù)的格式
->addHeaders([
'Content-Type'=>'application/json'
])
->send();
$info = json_decode(($response->content), true);
var_dump($info);
}
請(qǐng)求發(fā)送后，服務(wù)器將返回標(biāo)準(zhǔn)JSON字符串：
?<?php
//type=fcl,整柜
[
'data' => [
[
'pol_name' => '深圳',//起運(yùn)港中文
'pod_name' => '利馬索爾',//目的港中文
'ship_name' => '地中海航運(yùn)',//船公司中文
'pol' => 'CNSZN',//起運(yùn)港簡(jiǎn)碼
'pod' => 'THBKK',//目的港簡(jiǎn)碼
'shipowner' => 'MSC',//船公司簡(jiǎn)碼
'size20gp' => '1870',//20gp，美元
'size40gp' => '2890',//40gp，美元
'size40hc' => '2890',//40hc，美元
'size45hc' => '2890',//45hc，美元
'cls' => '1',//截關(guān)，周一
'etd' => '4',//開(kāi)船，周四
'tt' => '50',//航程，50天
'transit' => '',//中轉(zhuǎn)港
'stdate' => '2025-05-13',//有效期(起)
'enddate' => '2025-05-31',//有效期(止)
'note' => '',//備注
],
],
'msg' => '操作成功',
'code' => 1,
]
//type=lcl,拼箱
[
'data' => [
[
'pol_name' => '深圳',//起運(yùn)港中文
'pod_name' => '利馬索爾',//目的港中文
'ship_name' => '地中海航運(yùn)',//船公司中文
'pol' => 'CNSZN',//起運(yùn)港簡(jiǎn)碼
'pod' => 'THBKK',//目的港簡(jiǎn)碼
'shipowner' => 'MSC',//船公司簡(jiǎn)碼
'price' => '1870',//價(jià)格，美元
'cls' => '1',//截關(guān)，周一
'etd' => '4',//開(kāi)船，周四
'tt' => '50',//航程，50天
'transit' => '',//中轉(zhuǎn)港
'tons'=>'1:500',//計(jì)費(fèi)噸
'warehouse'=>'YTL',//服務(wù)類(lèi)型
'note' => '',//備注
],
],
'msg' => '操作成功',
'code' => 1,
]
請(qǐng)注意，所有的響應(yīng)都包含在JSON對(duì)象result根元素中，響應(yīng)對(duì)象中的 "code" 字段包含了請(qǐng)求的狀態(tài)，未出現(xiàn) 任何錯(cuò)誤時(shí)code的值為1，當(dāng)code值為1之外的值時(shí)，響應(yīng)對(duì)象中可能會(huì)包含一個(gè)附加的 msg 字段，此字段詳細(xì)地說(shuō)明了給定狀態(tài)代碼背后的原因。
響應(yīng)字段說(shuō)明，列表如下：
| 字段(屬性) | 說(shuō)明 |
|---|---|
| code | 請(qǐng)求狀態(tài) 1：成功 0:失敗 |
| msg | 返回包含的錯(cuò)誤信息。 |
| data | 數(shù)據(jù) |
為保障系統(tǒng)穩(wěn)定，服務(wù)器原子性（atomicity）數(shù)據(jù)統(tǒng)計(jì)機(jī)制會(huì)精確統(tǒng)計(jì)用戶(hù)每一次請(qǐng)求行為，超出請(qǐng)求頻率后系統(tǒng)會(huì)自動(dòng)鎖定用戶(hù)請(qǐng)求60（S）,超出請(qǐng)求上限后，系統(tǒng)將返回錯(cuò)誤信息。
單位時(shí)間（天）內(nèi)，用戶(hù)請(qǐng)求上限：1000次；
單位時(shí)間（分）內(nèi)，最大用戶(hù)并發(fā)請(qǐng)求30次；
*此值可能會(huì)隨著用戶(hù)的實(shí)際需求適時(shí)做出相應(yīng)調(diào)整，以保障用戶(hù)的最大需求。
用戶(hù)使用此接口時(shí)，應(yīng)在醒目位置顯示JSON對(duì)象中l(wèi)ink字段所包含的數(shù)據(jù)來(lái)源信息。