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

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

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

Connect AI を構成

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

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

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

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

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

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

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

   まず、OAuth アプリを作成する必要があります。 https://app.misoca.jp/oauth2/applications に移動し、「新しいアプリケーションを作成する」ボタンをクリックしてください。アプリケーション名を入力し、リダイレクトURL を指定して、「登録する」をクリックします。そうすると、クライアントシークレットとクライアントID が表示されます。

   次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

   以下の接続プロパティを設定した後、接続の準備が整います。

   • AuthScheme：OAuth に設定してください。
   • OAuthClientID：アプリケーション設定で指定されたOAuth クライアントID に設定してください。
   • OAuthClientSecret：アプリケーション設定で指定されたOAuth クライアントシークレットに設定してください。
   • CallbackURL：アプリケーション設定で指定したリダイレクトURI に設定してください。
   • InitiateOAuth：GETANDREFRESH に設定してください。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
   
4. Create & Test をクリックします。
5. 「Add Misoca Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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 のオブジェクト指向インターフェースを使ってMisoca のデータにアクセスできます。以下のコードはContacts テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

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