OData SDK for PHP を使ってJotForm のデータを取得
CData Connect AI はJotForm のデータをWeb サービスとして公開します。 この記事の手順を実行することで、JotForm のデータをPHP オブジェクトとして扱うことができるようになります。
CData Connect AI はJotForm のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からJotForm のデータへのリアルタイム連携を実現します。
Connect AI を構成
ODataPHP SDK でJotForm のデータを操作するには、Connect AI からJotForm に接続し、コネクションにユーザーアクセスを提供してJotForm のデータのOData エンドポイントを作成する必要があります。
JotForm に接続したら、目的のテーブルのOData エンドポイントを作成します。
パーソナルアクセストークンの追加
OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。
- Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
- 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
- PAT の名前を入力して Create をクリックします。
- パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。
Connect AI からJotForm に接続
CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。
- Connect AI にログインし、 Add Connection をクリックします。
- 「Add Connection」パネルから「JotForm」を選択します。
-
必要な認証プロパティを入力し、JotForm に接続します。
まず、Profile 接続プロパティをディスク上のJotForm プロファイルの場所に設定します(例:C:\profiles\JotForm.apip)。次に、ProfileSettings 接続プロパティをJotForm の接続文字列に設定します(以下を参照)。
JotForm API プロファイル設定
認証するには、JotForm API キーを見つけてください。API キーを取得するには、「My Account」>「API Section」>「Create a New API Key」に移動します。新しいAPI キーを作成したら、ProfileSettings 接続プロパティに設定できます。
カスタムエンタープライズAPI ドメイン
JotForm のエンタープライズ顧客には、デフォルトの「api.jotform.com」ドメインではなく、接続するためのカスタムAPI ドメインが提供されます。エンタープライズJotForm 顧客の場合は、ProfileSettings 接続プロパティ内でDomain を「your-domain.com」や「subdomain.jotform.com」などのカスタムAPI ホスト名に設定します。逆に、カスタムドメインがなく「api.jotform.com」に接続する必要がある場合は、Domain を未定義のままにしてAPIKey のみを設定します。
- Create & Test をクリックします。
- 「Add JotForm Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。
Connect AI にJotForm OData エンドポイントを追加する
JotForm に接続したら、目的のテーブルのOData エンドポイントを作成します。
- OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
- JotForm 接続(例:API1)を選択し、Next をクリックします。
- 使用するテーブルを選択し、「Confirm」をクリックします。
コネクションとOData エンドポイントを設定したら、ODataPHP SDK からJotForm のデータに接続できます。
-
まずは、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\APIEntities.phpこのコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。
CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。
認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。
-
これで、PHP のオブジェクト指向インターフェースを使ってJotForm のデータにアクセスできます。以下のコードはForms テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。
require_once 'APIEntities.php'; try{ $svc = new CDataAPI(); $forms = new Forms(); $forms->Status = 'ENABLED'; $svc->AddToForms($forms); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->forms()->Execute(); foreach($response->Result as $forms) echo $forms->Id."
"; } catch (Exception $e) { //CData Connect AI からのエラーをキャッチ echo $e->getError(), "\n"; }