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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Connect Cloud を構成

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

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

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

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

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

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

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

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

Connect Cloud からConfluence に接続

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

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

   Confluence 接続プロパティの取得・設定方法

   任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

   Confluence への認証

   Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。

   API トークン - Confluence Cloud アカウント

   トークンの取得

   アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

   トークンを使用する認証

   Cloud アカウントへの認証を行うには、以下を入力します。

   • AuthScheme：APIToken に設定。
   • User：Confluence サーバーに認証する際に使用されるユーザー。
   • APIToken：現在認証されているユーザーに紐づくAPI トークン。
   • Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

   Basic 認証 - Confluence Server インスタンス

   Server インスタンスへの認証を行うには、以下のように指定します。

   • AuthScheme：Basic に設定。
   • User：Confluence インスタンスに認証する際に使用されるユーザー。
   • Password：Confluence サーバーに認証する際に使われるパスワード。
   • Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
   その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。
   
4. Create & Test をクリックします。
5. 「Add Confluence Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にConfluence OData エンドポイントを追加する

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

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

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

1. まずは、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\ConfluenceEntities.php

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

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

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

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

   require_once 'ConfluenceEntities.php'; try{ $svc = new CDataAPI(); $pages = new Pages(); $pages->Id = '10000'; $svc->AddToPages($pages); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->pages()->Execute(); foreach($response->Result as $pages) echo $pages->Key."
"; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }