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

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

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

Connect AI を構成

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

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

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

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

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 からWave Financial に接続

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

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

   Wave Financial 接続プロパティの取得・設定方法

   Wave Financial は、データに接続する手段として、API トークンを指定する方法とOAuth 認証情報を使用する方法の2つを提供しています。

   API トークン

   Wave Financial API トークンを取得するには：
   1. Wave Financial アカウントにログインします。
   2. 左ペインのManage Applications に移動します。
   3. トークンを作成するアプリケーションを選択します。最初にアプリケーションを作成する必要がある場合があります。
   4. API トークンを生成するには、Create token をクリックします。

   OAuth

   Wave Financial はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

   ヘルプドキュメントでは、以下の3つの一般的な認証フローでのWave Financial への認証について詳しく説明しています。

   • デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
   • Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
   • ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。

   カスタムOAuth アプリケーションの作成方法や、組み込みOAuth 認証情報を使う場合でもカスタムOAuth アプリケーションの作成が推奨されるケースについては、ヘルプドキュメント の「カスタムOAuth アプリケーションの作成」セクションを参照してください。

   

4. Create & Test をクリックします。
5. 「Add Wave Financial Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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

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

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

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

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

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