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

加藤龍彦
デジタルマーケティング

API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でSuiteCRM エンティティを手軽に使用。

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

API Server の設定

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

SuiteCRM への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SuiteCRM」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、SuiteCRM への接続設定を行っていきましょう！
次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。
- Schema：suitecrmv4 に設定。
- Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
- User：SuiteCRM に紐づいているユーザーに設定。
- Password：SuiteCRM に紐づいているパスワードに設定。
SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュで説明しているように、メタデータをローカルに格納することをお勧めします。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。

Schema：suitecrmv4 に設定。
Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
User：SuiteCRM に紐づいているユーザーに設定。
Password：SuiteCRM に紐づいているパスワードに設定。

SuiteCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュで説明しているように、メタデータをローカルに格納することをお勧めします。

API Server のユーザー設定

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

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

SuiteCRM 用のAPI エンドポイントの作成

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

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

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

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

次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。

Schema：suitecrmv4 に設定。
Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
User：SuiteCRM に紐づいているユーザーに設定。
Password：SuiteCRM に紐づいているパスワードに設定。

さらに、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\SuiteCRM\
Unix or Mac OS X：~/cdata/SuiteCRM/

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

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

以下のようなコマンドにURL を渡します。
```
php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\SuiteCRMEntities.php
```
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

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

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

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

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

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ