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

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

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

Connect AI を構成

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

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

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

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

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

Connect AI からAha! に接続

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

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

   まず、Profile 接続プロパティをディスク上のAha! プロファイルの場所に設定します（例：C:\profiles\aha.apip）。次に、ProfileSettings 接続プロパティをAha! の接続文字列に設定します（以下を参照）。

   Aha! API プロファイル設定

   Aha! API はOAuth ベースの認証を使用します。

   まず、Aha! でOAuth アプリを登録する必要があります。これはAha! アカウントの「Settings」>「Personal」>「Developer」>「OAuth Applications」から行えます。また、Aha アカウントのドメイン名をDomain に設定します。例えば、Aha アカウントがacmeinc.aha.io の場合、Domain は「acmeinc」となります。

   以下の項目を接続文字列に設定すると、接続できるようになります。

   • AuthScheme：OAuth に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
   • OAuthClientId：アプリ設定で指定されたclient_id に設定します。
   • OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
   • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
   • Domain：ProfileSettings でAha ドメインに設定します。
   
4. Create & Test をクリックします。
5. 「Add Aha! Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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

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

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

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

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

   
   require_once 'APIEntities.php';
   try{
     $svc = new CDataAPI();
     $ideas = new Ideas();
     $ideas->AssignedToUserId = 'my_user_id';
     $svc->AddToIdeas($ideas);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->ideas()->Execute();
     foreach($response->Result as $ideas)
       echo $ideas->Id."
   ";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }