stuart client phpダウンロード - stuart client phpソースコードダウンロード

スチュアートPHPクライアント

Stuart APIが提供するすべてのエンドポイントの完全なドキュメントについては、Stuart APIドキュメントにアクセスできます。

Changelog

changelogにアクセスしてください

デモを実行します

 cd demo
docker build -t stuartphpdemo .
export PATH_TO_PROJECT= " /PUT/HERE/YOUR/PATH/TO/PROJECT/stuart-client-php "
docker run -v $PATH_TO_PROJECT /src:/app/vendor/stuartapp/stuart-client-php/src stuartphpdemo

インストール

作曲家経由：

$ composer require stuartapp/stuart-client-php

使用法

クライアントを初期化します
ジョブを作成します
1. ミニマリスト
2. 完了
  1. ピックアップでのスケジュールで
  2. ドロップオフ時のスケジューリング
  3. スタッキング付き（マルチドロップ）
仕事を得る
ジョブをキャンセルします
ジョブを検証します
配達をキャンセルします
価格を取得します
ピックアップにジョブETAを取得します
カスタムリクエスト

ライブラリをインポートします

作曲家がインストールされていない場合は、インストールしてください。

$ curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

あなたのプロジェクトにライブラリを追加します：

$ composer require stuartapp/stuart-client-php

オートローディング

このライブラリからすべてのクラスをロードするには、スチュアートコードの開始時にオートロードを実行するだけです

 <?php
require __DIR__ . ' /vendor/autoload.php ' ;

$ environment =  Stuart  Infrastructure Environment:: SANDBOX ;

資格情報を取得します

サンドボックス（テスト環境、クーリエはボットです）https：//dashboard.sandbox.stuart.com/settings/api

プロダクション（Real World、Real Couriers）https://dashboard.stuart.com/settings/api

クライアントを初期化します

 $ environment =  Stuart  Infrastructure Environment:: SANDBOX ;
$ api_client_id = ' REPLACE_BY_YOU_CLIENT_ID_HERE ' ; // can be found here: https://admin.sandbox.stuart.com/client/api
$ api_client_secret = ' REPLACE_BY_YOUR_CLIENT_SECRET_HERE ' ; // can be found here: https://admin.sandbox.stuart.com/client/api
$ authenticator = new  Stuart  Infrastructure  Authenticator ( $ environment , $ api_client_id , $ api_client_secret );

$ httpClient = new  Stuart  Infrastructure HttpClient( $ authenticator )

$ client = new  Stuart  Client ( $ httpClient );

また、独自のGuzzleクライアントインスタンスをStuartHttpClientコンストラクターに渡すこともできます。

 $ guzzleClient = new  Guzzle  Client ();
$ httpClient = new  Stuart  Infrastructure  HttpClient ( $ authenticator , $ guzzleClient );

これは、GuzzleクライアントにMiddleWaresを接続する必要がある場合に役立ちます。

キャッシング

認証プロセスのキャッシュメカニズムを追加することを強くお勧めします。そのためには、 PsrSimpleCacheCacheInterfaceクラスを拡張して、独自のバージョンを実装するだけです。

使用できるディスクに基づくキャッシュが箱から出しています。それを使用するには、認証クラスの初期化を変更し、コンストラクターのキャッシュ実装を渡すだけです。

 $ diskCache = new  Stuart  Cache  DiskCache ( " stuart_cache.txt " );
$ authenticator = new  Stuart  Infrastructure  Authenticator ( $ environment , $ api_client_id , $ api_client_secret , $ diskCache );

トークンキャッシュの問題のデバッグ

これらのクラスの最後のコンストラクターパラメーターにtrue値を渡すことにより、DiskCache、Authenticator、およびHTTPClientクラスを初期化できます。

ジョブを作成します

重要：最小限のパラメーターセットでジョブを作成できる場合でも、配信プロセスがうまくいくために、できるだけ多くの情報を入力することを強くお勧めします。

ミニマリスト

パッケージサイズベース

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ client -> createJob ( $ job );

完了

パッケージサイズベース

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setComment ( ' Wait outside for an employee to come. ' )
    -> setContactCompany ( ' KFC Paris Barbès ' )
    -> setContactFirstName ( ' Martin ' )
    -> setContactLastName ( ' Pont ' )
    -> setContactPhone ( ' +33698348756 ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 3492B. 3e étage droite. Sonner à Durand. ' )
    -> setContactCompany ( ' Durand associates. ' )
    -> setContactFirstName ( ' Alex ' )
    -> setContactLastName ( ' Durand ' )
    -> setContactPhone ( ' +33634981209 ' )
    -> setPackageDescription ( ' Pizza box. ' )
    -> setClientReference ( ' 12345678ABCDE ' ); // Must be unique

$ client -> createJob ( $ job );

ピックアップでのスケジュールで

ジョブスケジューリングの詳細については、APIドキュメントを確認する必要があります。

 $ job = new  Stuart  Job ();

$ pickupAt = new  DateTime ( ' now ' , new DateTimeZone ( ' Europe/Paris ' ));
$ pickupAt -> add ( new  DateInterval ( ' PT2H ' ));

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setPickupAt ( $ pickupAt );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ client -> createJob ( $ job );

ドロップオフ時のスケジューリング

ジョブスケジューリングの詳細については、APIドキュメントを確認する必要があります。

この機能は、ドロップオフが1つだけで使用できることに注意してください。

 $ job = new  Stuart  Job ();

$ dropoffAt = new  DateTime ( ' now ' , new DateTimeZone ( ' Europe/Paris ' ));
$ dropoffAt -> add ( new  DateInterval ( ' PT2H ' ));

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setDropoffAt ( $ dropoffAt );

$ client -> createJob ( $ job );

艦隊ターゲティング付き

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ job -> setFleets ( array ( 1 ));

$ client -> createJob ( $ job );

エンドカスタマータイムウィンドウ情報（メトリック目的でのみ使用）

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ now = new DateTime ();
$ later = new DateTime ();
$ later = $ later -> modify ( ' +15 minutes ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setEndCustomerTimeWindowStart ( new DateTime ())
    -> setEndCustomerTimeWindowEnd ( $ later );

$ client -> createJob ( $ job );

スタッキング付き（マルチドロップ）

パッケージサイズベース

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setComment ( ' Wait outside for an employee to come. ' )
    -> setContactCompany ( ' KFC Paris Barbès ' )
    -> setContactFirstName ( ' Martin ' )
    -> setContactLastName ( ' Pont ' )
    -> setContactPhone ( ' +33698348756 ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 3492B. 3e étage droite. Sonner à Durand. ' )
    -> setContactCompany ( ' Durand associates. ' )
    -> setContactFirstName ( ' Alex ' )
    -> setContactLastName ( ' Durand ' )
    -> setContactPhone ( ' +33634981209 ' )
    -> setPackageDescription ( ' Red packet. ' )
    -> setClientReference ( ' 12345678ABCDE ' ); // Must be unique;

$ job -> addDropOff ( ' 12 avenue claude vellefaux, 75010 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 92A42. 2e étage gauche ' )
    -> setContactFirstName ( ' Maximilien ' )
    -> setContactLastName ( ' Lebluc ' )
    -> setContactPhone ( ' +33632341209 ' )
    -> setPackageDescription ( ' Blue packet. ' )
    -> setClientReference ( ' ABCDE213124 ' ); // Must be unique

$ client -> createJob ( $ job );

仕事を得る

ジョブを正常に作成したら、この方法で取得できます。

 $ jobId = 126532 ;
$ job = $ client -> getJob ( $ jobId );

または、新しいジョブを作成するとき：

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ jobWithRoute = $ client -> createJob ( $ job );

$ jobWithRoute -> getDeliveries ();

Stuart APIは、あなたに代わって最適なルートを決定します。そのため、 getDeliveries()メソッドは、ジョブがまだ作成されていないときに空の配列を返します。 getDeliveries()メソッドは、ジョブが作成されるとすぐにDeliveryの配列を返します。

ジョブをキャンセルします

ジョブを正常に作成したら、この方法でキャンセルできます。

 $ jobId = 126532 ;
$ result = $ client -> cancelJob ( $ jobId );

結果は、ジョブがキャンセルされた場合、ブール値をtrue保持します。エラーがある場合、エラーオブジェクトが含まれます。

キャンセルの仕組みの詳細については、専用のドキュメントセクションを参照してください。

ジョブを検証します

ジョブを作成する前に、検証することができます（配信エリアとアドレス形式を制御）。ジョブの検証はオプションであり、ジョブを作成することを妨げません。

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ result = $ client -> validateJob ( $ job );

結果は、ジョブが有効な場合、ブール値をtrue保持します。エラーがある場合、エラーオブジェクトが含まれます。

アドレスを検証します

アドレスを検証して、そこでピックアップ /配信できるかどうかを確認することをお勧めします。電話番号は、アドレスが十分に具体的である場所でのみオプションです。

 $ client -> validatePickupAddress ( ' Pau Claris, 08037 Barcelona ' , ' +34677777777 ' );
$ client -> validatePickupAddress ( ' Pau Claris 186, 08037 Barcelona ' );
$ client -> validateDropoffAddress ( ' Pau Claris, 08037 Barcelona ' , ' +34677777777 ' );

配達をキャンセルします

配信を正常に作成したら、この方法でキャンセルできます。

 $ deliveryId = 126532 ;
$ result = $ client -> cancelDelivery ( $ deliveryId );

価格を取得します

ジョブを作成する前に、価格設定を求めることができます。価格設定を要求することはオプションであり、仕事の作成を妨げません。

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ pricing = $ client -> getPricing ( $ job );

$ pricing -> amount ; // example: 11.5
$ pricing -> currency ; // example: "EUR"

ピックアップにジョブETAを取得します

ジョブを作成する前に、ピックアップの場所に到着した推定時間を要求できます（数秒で表されます）。 ETAを要求することはオプションであり、仕事の作成を妨げません。

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ eta = $ client -> getEta ( $ job );

$ eta -> eta ; // example: 672

カスタムリクエスト

StuartClientに頼らずに、自分でリクエストを送信することもできます。 StuartClientでまだ利用できないエンドポイントを使用し、 StuartAuthenticatorお楽しみください。

 $ apiResponse = $ httpClient -> performGet ( ' /v2/jobs?page=1 ' );
$ apiResponse -> success ();
$ apiResponse -> getBody ();

拡大する