OData SDK for PHP を使ってスマレジのデータを取得

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

CData Connect AI を使えば、OData を使ってスマレジのデータにアクセスできます。CData Connect AI とOData PHP SDK を利用することで、スマレジのエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

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

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

Connect AI を構成

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

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

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

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

「Users」ページに移動し、 Invite Users をクリックします。
新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
PAT の名前を入力して Create をクリックします。
パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からスマレジに接続

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

Connect AI にログインし、 Add Connection をクリックします。
「Add Connection」パネルから「スマレジ」を選択します。
必要な認証プロパティを入力し、スマレジに接続します。
スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。
- スマレジにログイン後、「設定」->「システム連携」->「スマレジAPI 設定」に移動します。
- 「API受信設定」セクションにある「受信機能を利用する」を「利用する」に変更し、「アクセストークンの生成」をクリックし、AccessToken を取得します。
- 次に必要なAPI アクセスを有効にするため、「機能設定」セクションで必要な機能を「利用する」に変更します。
ContractId： アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken： 受信設定セクションのアクセストークン。
Create & Test をクリックします。
「Add スマレジ Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にスマレジ OData エンドポイントを追加する

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

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

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

まずは、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\SmaregiEntities.php
	    
```
このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

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

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

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

require_once 'SmaregiEntities.php';
try{
  $svc = new CDataAPI();
  $products = new Products();
  $products->ProductId = '666666';
  $svc->AddToProducts($products);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->products()->Execute();
  foreach($response->Result as $products)
    echo $products->ProductName."";
} catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
  echo $e->getError(), "\n";
}

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

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアルお問い合わせ

OData SDK for PHP を使ってスマレジのデータを取得