各製品の資料を入手。
詳細はこちら →
OData SDK for PHP を使ってSquare のデータを取得
CData Connect Cloud を使えば、OData を使ってSquare のデータにアクセスできます。CData Connect Cloud とOData PHP SDK を利用することで、Square のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。
最終更新日：2022-11-25
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
CData Connect Cloud はSquare のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Square のデータをPHP オブジェクトとして扱うことができるようになります。
CData Connect Cloud はSquare のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からSquare のデータへのリアルタイム連携を実現します。
Connect Cloud アカウントの取得
以下のステップを実行するには、CData Connect Cloud のアカウントが必要になります。こちらから製品の詳しい情報とアカウント作成、30日間無償トライアルのご利用を開始できますので、ぜひご利用ください。
Connect Cloud を構成
ODataPHP SDK でSquare のデータを操作するには、Connect Cloud からSquare に接続し、コネクションにユーザーアクセスを提供してSquare のデータのOData エンドポイントを作成する必要があります。
Square に接続したら、目的のテーブルのOData エンドポイントを作成します。
（オプション）新しいConnect Cloud ユーザーの追加
必要であれば、Connect Cloud 経由でSquare に接続するユーザーを作成します。
- 「Users」ページに移動し、 Invite Users をクリックします。
- 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
- 「Users」ページからユーザーを確認および編集できます。
パーソナルアクセストークンの追加
OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。
- Connect Cloud アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
- 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
- PAT の名前を入力して Create をクリックします。
- パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。
Connect Cloud からSquare に接続
CData Connect Cloud では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。
- Connect Cloud にログインし、 Add Connection をクリックします。
- 「Add Connection」パネルから「Square」を選択します。
-
必要な認証プロパティを入力し、Square に接続します。
Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。
追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。
- Create & Test をクリックします。
- 「Add Square Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。
Connect Cloud にSquare OData エンドポイントを追加する
Square に接続したら、目的のテーブルのOData エンドポイントを作成します。
- OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
- Square 接続（例：Square1）を選択し、Next をクリックします。
- 使用するテーブルを選択し、「Confirm」をクリックします。
コネクションとOData エンドポイントを設定したら、ODataPHP SDK からSquare のデータに接続できます。
-
まずは、ODataPHP SDK を使用してCData Connect Cloud が公開したWeb サービスに接続するプロキシクラスを作成します。
URI 部分を書き換えて、次のようなコマンドを実行してください。
php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\SquareEntities.phpこのコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。
CData Connect Cloud およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect Cloud はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。
認証済みのユーザーは、CData Connect Cloud の管理コンソールのUsers セクションで設定できます。
-
これで、PHP のオブジェクト指向インターフェースを使ってSquare のデータにアクセスできます。以下のコードはRefunds テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。
require_once 'SquareEntities.php'; try{ $svc = new CDataAPI(); $refunds = new Refunds(); $refunds->Type = 'FULL'; $svc->AddToRefunds($refunds); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->refunds()->Execute(); foreach($response->Result as $refunds) echo $refunds->Reason.""; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }
関連コンテンツ
