首頁>PHP源碼>其他類別
下載

fancourier api v2.0

目錄

  • 資訊
  • 安裝
    • 要求
    • 作曲家
  • 用法
    • 驗證
    • 取得預估運費
    • 建立運單
    • 大量建立運單
    • 追蹤運單
    • 大量追蹤運送單
    • 風扇盒
    • 列印運單 (PDF)
    • 列印運單 (ZPL)
    • 列印運單 Html
    • 刪除運單
  • 執照

資訊

此版本的庫專為fancourier api v2.0（基於 JSON 的回應）而設計。該程式碼可以運行，並且有所有 API 請求的範例，但是文件尚未準備好。

所有請求都有getData()方法，該方法傳回 API 的未處理回應。附加函數取決於回應物件類型來傳回處理後的資料。

安裝

要求

  • PHP >= 7.0

注意目前它設計為與 PHP 7.0 及更高版本一起使用。
但是，計劃為所有函數添加類型和返回類型聲明，這將要求至少達到 PHP 8.1

作曲家

透過 Composer 獲取包

composer require shusaura85/fancourier-api

手動的

如果不使用 Composer，則需要手動 require autoload.php文件

 require_once ' /path/to/fancourier-api/src/autoload.php ' ;

用法

目前還沒有完整且正確的文檔。但是，您可以提出的每種請求類型都有範例。
在其中您還可以找到每個request 、 response和object的帶有完整功能清單的註釋。

驗證

建立Fancourier.php的新實例，提供client_id 、 username 、 password和token 。 

 $ clientId = ' your_client_id ' ;
$ username = ' your_username ' ;
$ password = ' your_password ' ;
$ token = ' load from cache or leave as empty string ' ;

$ fan = new Fancourier  Fancourier ( $ clientId , $ username , $ password , $ token );

或者您可以使用測試實例靜態方法： 

 $ fan = Fancourier Fancourier:: testInstance ( $ token );

產生的令牌的有效期為 24 小時，在此期限後必須刷新。您可以使用下列函數來取得產生的令牌： 

 $force_refresh = false;
$token = $fan->getToken($force_refresh);

如果建立實例時指定的token為空，則會在第一次要求時自動產生。

取得預估運費

要求

 $ request = new Fancourier  Request  GetCosts ();
$ request
    -> setParcels ( 1 )
    -> setWeight ( 1 )
    -> setCounty ( ' Arad ' )
    -> setCity ( ' Aciuta ' )
    -> setDeclaredValue ( 125 );

回覆

 if ( $ response -> isOk ()) {
    var_dump ( $ response -> getData ()); // raw data
    // or just the information you want
    echo " extraKmCost: " . $ response -> getKmCost (). ' <br /> ' ;
    echo " weightCost: " . $ response -> getWeightCost (). ' <br /> ' ;
    echo " insuranceCost: " . $ response -> getInsuranceCost (). ' <br /> ' ;
    echo " optionsCost: " . $ response -> getOptionsCost (). ' <br /> ' ;
    echo " fuelCost: " . $ response -> getFuelCost (). ' <br /> ' ;
    echo " costNoVAT: " . $ response -> getCost (). ' <br /> ' ;
    echo " vat: " . $ response -> getCostVat (). ' <br /> ' ;
    echo " total: " . $ response -> getCostTotal (). ' <br /> ' ;
} else {
    var_dump ( $ response -> getErrorMessage ());
    print_r ( $ response -> getAllErrors ());
}

建立運單

要求

 $ awb = new Fancourier  Objects  AwbIntern ();
$ awb
    -> setService ( ' Cont Colector ' )
    -> setPaymentType ( Fancourier  Request CreateAwb:: TYPE_SENDER )
    -> setParcels ( 1 )
    -> setWeight ( 1 )    // in kg
    -> setReimbursement ( 199.99 ) // suma de incasat
    -> setDeclaredValue ( 1000 )
    -> setSizes ( 10 , 5 , 1 ) // in cm
    -> setNotes ( ' testing notes ' )
    -> setContents ( ' SKU-1, SKU-2 ' )
    -> setRecipientName ( " John Ivy " )
    -> setPhone ( ' 0723000000 ' )
    -> setCounty ( ' Arad ' )
    -> setCity ( ' Aciuta ' )
    -> setStreet ( ' Str Lunga ' )
    -> setNumber ( 1 )
    -> addOption ( ' S ' )
    -> addOption ( ' X ' );

$ request = new Fancourier  Request  CreateAwb ();
$ request -> addAwb ( $ awb );

回覆

 $ response = $ fan -> createAwb ( $ request );

if ( $ response -> isOk ()) {
    var_dump ( $ response -> getData ()); // raw data
    // or the AWBIntern objects updated with the response information
    $ al = $ response -> getAll ();
    echo " Count: " . count ( $ al ). " <br /> " ;
    foreach ( $ al as $ awbr )
        {
        if ( $ awbr -> hasErrors ())
            {
            print_r ( $ awbr -> getErrors ());
            }
        else
            {
            echo " AWB: " . $ awbr -> getAwb (). " <br /> " ;
            }
        }
    
} else {
    var_dump ( $ response -> getErrorMessage ());
}

大量建立運單

與先前的版本不同，不再有 CreateAwbBulk 要求。只需建立盡可能多的 AWBIntern 物件並將它們新增至請求中

要求

 $ request = new Fancourier  Request  CreateAwb ();

// create the first awb
$ awb = new Fancourier  Objects  AwbIntern ();
$ awb
    -> setService ( ' Cont Colector ' )
    . . . .
    -> addOption ( ' X ' );

// add it to the request
$ request -> addAwb ( $ awb );

// create another awb
$ awb = new Fancourier  Objects  AwbIntern ();
$ awb
    -> setService ( ' Cont Colector ' )
    . . . .
    -> addOption ( ' X ' );

// add it to the request
$ request -> addAwb ( $ awb );

// create another awb
$ awb = new Fancourier  Objects  AwbIntern ();
$ awb
    -> setService ( ' Cont Colector ' )
    . . . .
    -> addOption ( ' X ' );

// add it to the request
$ request -> addAwb ( $ awb );

回覆

 $ response = $ fan -> createAwb ( $ request );

if ( $ response -> isOk ()) {
    var_dump ( $ response -> getData ()); // raw data
    // or the AWBIntern objects updated with the response information
    $ al = $ response -> getAll ();
    echo " Count: " . count ( $ al ). " <br /> " ;
    foreach ( $ al as $ awbr )
        {
        if ( $ awbr -> hasErrors ())
            {
            print_r ( $ awbr -> getErrors ());
            }
        else
            {
            echo " AWB: " . $ awbr -> getAwb (). " <br /> " ;
            }
        }
    
} else {
    var_dump ( $ response -> getErrorMessage ());
}

追蹤運單

要求

 $ request = new Fancourier  Request  TrackAwb ();
$ request
    -> setAwb ( ' 2150900120086 ' );

回覆

 $ response = $ fan -> trackAwb ( $ request );

if ( $ response -> isOk ()) {
    print_r ( $ response -> getData ()); // raw data
    print_r ( $ response -> getAll ()); // array of AwbTracker objects
} else {
    var_dump ( $ response -> getErrorMessage ());
}

大量追蹤運送單

與先前的版本不同，您可以使用相同的 TrackAwb() 物件並根據需要添加任意數量的 AWB 來追蹤

要求

 $ request = new Fancourier  Request  TrackAwb ();
$ request
    -> addAwb ( ' 2150900120084 ' )
    -> addAwb ( ' 2150900120085 ' )
    -> addAwb ( ' 2150900120086 ' );

回覆

 $ response = $ fan -> trackAwb ( $ request );

if ( $ response -> isOk ()) {
    print_r ( $ response -> getData ()); // raw data
    print_r ( $ response -> getAll ()); // array of AwbTracker objects
} else {
    var_dump ( $ response -> getErrorMessage ());
}

風扇盒

現在您可以輕鬆取得有關可用 FANBox 和 PayPoint 位置的資訊。 FAN Courier 稱那裡為 PUDO（接送服務）。
為他們建立 AWB 時，將位址設定為此處收到的 PUDO 位址，並使用所選 PUDO 的 ID 呼叫函數setPickupLocation(PUDO_ID) 。

要求

 $ request = new Fancourier  Request  GetPudo ();
$ request
    -> setType ( Fancourier  Request GetPudo:: PUDO_FANBOX );

回覆

 $ response = $ fan -> getPudo ( $ request );

if ( $ response -> isOk ()) {
    print_r ( $ response -> getData ()); // raw data
    print_r ( $ response -> getAll ()); // array of PUDO objects
} else {
    var_dump ( $ response -> getErrorMessage ());
}

列印運單

列印請求可以使用單一請求列印一份或多份 AWB。
您可以使用->setSize()函數指定 AWB 的大小。可用選項有： empty 、 A4 、 A5和A6 。 A6只能與 ePod 選項一起使用。
PDF 列印是預設的列印模式。
請注意，您不能同時要求 ZPL 和 PDF。如果設置，使用setPdf()將自動停用 ZPL 選項。

要求

 $ request = new Fancourier  Request  PrintAwb ();
$ request
    -> setPdf ( true )
    -> setAwb ( ' 2150900120086 ' );

回覆

 $ response = $ fan -> printAwb ( $ request );
if ( $ response -> isOk ()) {
    echo $ response -> getData ();
} else {
    var_dump ( $ response -> getErrorMessage ());
    print_r ( $ response -> getAllErrors ());
}

列印運單 ZPL

您可以要求 ZPL 格式（Zebra 程式語言）的航空單以與標籤印表機搭配使用。
請注意，您不能同時要求 ZPL 和 PDF。如果設置，使用setZpl()將自動停用 PDF 選項。

要求

 $ request = new Fancourier  Request  PrintAwb ();
$ request
    -> setZpl ( true )
    -> setAwb ( ' 2150900120086 ' );

回覆

 $ response = $ fan -> printAwb ( $ request );
if ( $ response -> isOk ()) {
    echo $ response -> getData ();
} else {
    var_dump ( $ response -> getErrorMessage ());
    print_r ( $ response -> getAllErrors ());
}

列印運單 Html

如果您想要 HTML 格式的運單，只需使用 ->setPdf(false) 即可取得 HTML 資料而不是 PDF。

要求

 $ request = new Fancourier  Request  PrintAwb ();
$ request
    -> setPdf ( false )
    -> setAwb ( ' 2150900120086 ' );

回覆

 $ response = $ fan -> printAwb ( $ request );
if ( $ response -> isOk ()) {
    echo $ response -> getData ();
} else {
    var_dump ( $ response -> getErrorMessage ());
    print_r ( $ response -> getAllErrors ());
}

刪除運單

要求

 $ request = new Fancourier  Request  DeleteAwb ();
$ request -> setAwb ( ' 2150900120086 ' );

回覆

 $ response = $ fan -> deleteAwb ( $ request );
if ( $ response -> isOk ()) {
    var_dump ( $ response -> getData ());
} else {
    var_dump ( $ response -> getErrorMessage ());
}

執照

fancourier api是根據 MIT 許可證授權的開源軟體。

展開
附加信息
相關應用
爲您推薦
相關資訊 全部