各製品の資料を入手。
詳細はこちら →
OData SDK for PHP を使ってWave Financial のデータを取得
CData Connect Server を使えば、OData を使ってWave Financial のデータにアクセスできます。CData Connect Server とOData PHP SDK を利用することで、Wave Financial のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。
最終更新日：2022-11-25
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Connect Server はWave Financial のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Wave Financial のデータをPHP オブジェクトとして扱うことができるようになります。
CData Connect Server はWave Financial のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からWave Financial のデータへのリアルタイム連携を実現します。
Wave Financial の仮想OData API エンドポイントを作成
まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。
- CData Connect Server にログインして、「DATA MODEL」をクリックします。
- 利用できるデータソースアイコンから"Wave Financial" を選択します。
-
Wave Financial に接続するために必要なプロパティを入力します。
Wave Financial 接続プロパティの取得・設定方法
Wave Financial は、データに接続する手段として、API トークンを指定する方法とOAuth 認証情報を使用する方法の2つを提供しています。
API トークン
Wave Financial API トークンを取得するには：- Wave Financial アカウントにログインします。
- 左ペインのManage Applications に移動します。
- トークンを作成するアプリケーションを選択します。最初にアプリケーションを作成する必要がある場合があります。
- API トークンを生成するには、Create token をクリックします。
OAuth
Wave Financial はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。ヘルプドキュメントでは、以下の3つの一般的な認証フローでのWave Financial への認証について詳しく説明しています。
- デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
- Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
- ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。
カスタムOAuth アプリケーションの作成についての情報と、組み込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、ヘルプドキュメント の「カスタムOAuth アプリケーションの作成」セクションを参照してください。
- 「Test Connection」をクリックします。
- 「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
- API タブをクリックして OData API エンドポイントが生成されていることを確認します。
コネクションとOData エンドポイントを設定したら、PHP からWave Financial のデータに接続できます。
-
まずは、ODataPHP SDK を使用してCData Connect Server が公開したWeb サービスに接続するプロキシクラスを作成します。
URI 部分を書き換えて、次のようなコマンドを実行してください。
php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\WaveFinancialEntities.phpこのコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。
CData Connect Server およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect Server はOData エンドポイントへのアクセスが認可されたユーザーの認証に、認証トークンを使用します。認証トークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。
認証済みのユーザーは、CData Connect Server の管理コンソールのUsers セクションで設定できます。
-
これで、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 Server からのエラーをキャッチ echo $e->getError(), "\n"; }
