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

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

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

Connect AI を構成

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

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

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

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

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 からShopify に接続

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

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

   それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

   アクセストークンによる接続

   アクセストークン経由の接続には、以下の2つのステップが必要です。

   1. Shopify の管理画面でアクセストークンを作成
   2. アクセストークンを使用して認証

   アクセストークンの作成

   まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

   1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
   2. Develop apps をクリックしてCreate an app を選択します
   3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
   4. Save をクリックします
   5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
      • unauthenticated_read_content
   6. Save をクリックします
   7. API Credentials を選択します
   8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
   9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

   アクセストークンによる認証

   続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

   • AuthScheme：AccessToken に設定
   • AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

   OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

   
4. Create & Test をクリックします。
5. 「Add Shopify Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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\ShopifyEntities.php
   	    

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

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

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

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

   require_once 'ShopifyEntities.php';
   try{
     $svc = new CDataAPI();
     $customers = new Customers();
     $customers->FirstName = 'jdoe1234';
     $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";
   }