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

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

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

Connect AI を構成

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

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

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

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

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 からAvalara AvaTax に接続

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

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

   Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。

   • User：ユーザー名に設定します。
   • Password：パスワードに設定します。

   サンドボックス環境を使用している場合には、オプションで次を設定してください。

   • UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。

   アカウント番号とライセンスキーを使用して認証する

   または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。

   • AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
   • LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。
   
4. Create & Test をクリックします。
5. 「Add Avalara AvaTax Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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\AvalaraAvataxEntities.php
   	    

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

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

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

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

   require_once 'AvalaraAvataxEntities.php';
   try{
     $svc = new CDataAPI();
     $transactions = new Transactions();
     $transactions->Code = '051349';
     $svc->AddToTransactions($transactions);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->transactions()->Execute();
     foreach($response->Result as $transactions)
       echo $transactions->Id."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }