OData SDK for PHP を使ってBigCommerce のデータを取得

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

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

Connect AI を構成

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

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

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

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

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

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

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

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

Connect AI からBigCommerce に接続

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

1. Connect AI にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「BigCommerce」を選択します。
3. 必要な認証プロパティを入力し、BigCommerce に接続します。

   BigCommerce 認証は標準のOAuth フローに基づいています。

   Store ID の取得

   BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

   1. BigCommerce アカウントにログインします。
   2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
   3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
   4. 画面にAPI Path という名前のテキストボックスが表示されます。
   5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
   6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
   7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

   パーソナルアクセストークンの取得

   加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

   1. BigCommerce アカウントにログインします。
   2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
   3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
   4. アカウント名を入力します。
   5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
   6. 「保存」をクリックします。

   BigCommerce への認証

   次に、以下を設定してデータに接続できます。
   • StoreId：API Path テキストボックスから取得したStore ID に設定。
   • OAuthAccessToken：生成したトークンに設定。
   • InitiateOAuth：OFF に設定。
   
4. Create & Test をクリックします。
5. 「Add BigCommerce Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にBigCommerce OData エンドポイントを追加する

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

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

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

1. まずは、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\BigCommerceEntities.php
   	    

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

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

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

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

   require_once 'BigCommerceEntities.php';
   try{
     $svc = new CDataAPI();
     $customers = new Customers();
     $customers->FirstName = 'Bob';
     $svc->AddToCustomers($customers);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->customers()->Execute();
     foreach($response->Result as $customers)
       echo $customers->FirstName."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }