OData SDK for PHP を使ってTaxJar のデータを取得

CData Connect AI はTaxJar のデータをWeb サービスとして公開します。 この記事の手順を実行することで、TaxJar のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はTaxJar のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からTaxJar のデータへのリアルタイム連携を実現します。

Connect AI を構成

ODataPHP SDK でTaxJar のデータを操作するには、Connect AI からTaxJar に接続し、コネクションにユーザーアクセスを提供してTaxJar のデータのOData エンドポイントを作成する必要があります。

TaxJar に接続したら、目的のテーブルのOData エンドポイントを作成します。

（オプション）新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でTaxJar に接続するユーザーを作成します。

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からTaxJar に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect AI にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「TaxJar」を選択します。
3. 必要な認証プロパティを入力し、TaxJar に接続します。

   TaxJar API への認証には、まず初めにTaxJar UI からAPI キーを取得する必要があります。

   NOTE：API の利用は、Professional およびPremium TaxJar プランでのみ可能です。

   すでにProfessional またはPremium プランをお持ちの方は、TaxJar UI にログインして、「アカウント」->「TaxJar API」に移動するとAPI キーを確認できます。 API キーを取得したら、APIKey 接続プロパティに設定できます。

   その他の注意事項

   • デフォルトでは、エンティティが日付範囲フィルタをサポートしている場合、CData コネクタは過去3か月のデータを取得します。StartDate を設定して、取得するデータの最小作成日を指定できます。
   • API キーがサンドボックスAPI アカウント用に作成されている場合は、UseSandbox をtrue に設定してください。ただし、すべてのエンドポイントが期待どおりに機能するとは限りません。詳しくは、TaxJar 開発者用ドキュメントを参照してください。
   
4. Create & Test をクリックします。
5. 「Add TaxJar Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にTaxJar OData エンドポイントを追加する

TaxJar に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. TaxJar 接続（例：TaxJar1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からTaxJar のデータに接続できます。

1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   
   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\TaxJarEntities.php
   	    

   このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

   CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

   認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

2. これで、PHP のオブジェクト指向インターフェースを使ってTaxJar のデータにアクセスできます。以下のコードはOrders テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   
   require_once 'TaxJarEntities.php';
   try{
     $svc = new CDataAPI();
     $orders = new Orders();
     $orders->TransactionID = '123';
     $svc->AddToOrders($orders);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->orders()->Execute();
     foreach($response->Result as $orders)
       echo $orders->TransactionID."
   ";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }