PHP のOData SDK を使用したWave Financial のデータのクエリ



CData API Server は、ADO.NET Provider for WaveFinancial（またはその他の250+ ADO.NET Providers のデータ）と組み合わせることでWeb サービスとしてWave Financial のデータを公開します。下記の手順に従って、Wave Financial のデータをオブジェクトとして使用します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなWave Financial OData サービスを作成していきましょう。

Wave Financial への接続

PHP からWave Financial のデータを操作するには、まずWave Financial への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Wave Financial」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Wave Financial への接続設定を行っていきましょう！

5. 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 アプリケーションの作成」セクションを参照してください。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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 アプリケーションの作成」セクションを参照してください。

API Server のユーザー設定

次に、API Server 経由でWave Financial にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Wave Financial 用のAPI エンドポイントの作成

ユーザーを作成したら、Wave Financial のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でWave Financial への接続を設定してユーザーを作成し、API Server でWave Financial データのAPI を追加しました。これで、OData 形式のWave Financial データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

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 アプリケーションの作成」セクションを参照してください。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

• Windows：C:\ProgramData\CData\WaveFinancial\
• Unix or Mac OS X：~/cdata/WaveFinancial/

Wave Financial エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

1. 以下のようなコマンドにURL を渡します。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\WaveFinancialEntities.php

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

   API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

   許可されたユーザーは、API Server の「Users」セクションで設定できます。

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

   require_once 'WaveFinancialEntities.php';
   try{
     $svc = new CData();
     $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) {    //catch errors from the API Server
     echo $e->getError(), "\n";
   }