各製品の資料を入手。
詳細はこちら →製品をチェック
製品の詳細・30日間の無償トライアルはこちら
CData ConnectOData SDK for PHP を使ってSuiteCRM のデータを取得
CData Connect Server を使えば、OData を使ってSuiteCRM のデータにアクセスできます。CData Connect Server とOData PHP SDK を利用することで、SuiteCRM のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。
加藤龍彦デジタルマーケティング
最終更新日:2022-11-25
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Connect Server はSuiteCRM のデータをWeb サービスとして公開します。 この記事の手順を実行することで、SuiteCRM のデータをPHP オブジェクトとして扱うことができるようになります。
CData Connect Server はSuiteCRM のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からSuiteCRM のデータへのリアルタイム連携を実現します。
SuiteCRM の仮想OData API エンドポイントを作成
まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。
- CData Connect Server にログインして、「DATA MODEL」をクリックします。
- 利用できるデータソースアイコンから"SuiteCRM" を選択します。
-
SuiteCRM に接続するために必要なプロパティを入力します。
次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。
- Schema:suitecrmv4 に設定。
- Url:SuiteCRM アプリケーションに紐づいているURL(例:http://suite.crm.com)に設定。
- User:SuiteCRM に紐づいているユーザーに設定。
- Password:SuiteCRM に紐づいているパスワードに設定。
SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。
- 「Test Connection」をクリックします。
- 「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
- API タブをクリックして OData API エンドポイントが生成されていることを確認します。
コネクションとOData エンドポイントを設定したら、PHP からSuiteCRM のデータに接続できます。
-
まずは、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\SuiteCRMEntities.php
このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。
CData Connect Server およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect Server はOData エンドポイントへのアクセスが認可されたユーザーの認証に、認証トークンを使用します。認証トークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。
認証済みのユーザーは、CData Connect Server の管理コンソールのUsers セクションで設定できます。
-
これで、PHP のオブジェクト指向インターフェースを使ってSuiteCRM のデータにアクセスできます。以下のコードはAccounts テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。
require_once 'SuiteCRMEntities.php'; try{ $svc = new CDataAPI(); $accounts = new Accounts(); $accounts->Industry = 'Manufacturing'; $svc->AddToAccounts($accounts); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->accounts()->Execute(); foreach($response->Result as $accounts) echo $accounts->Name.""; } catch (Exception $e) { //CData Connect Server からのエラーをキャッチ echo $e->getError(), "\n"; }
おl>