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

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

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

Connect AI を構成

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

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

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

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

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

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

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

   Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

   API キー認証

   ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

   1. Backlog の個人設定ページを開きます。
   2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
   3. ApiKey にAPI キーを指定します。
   4. URL はBacklog のテナントURL から取得できます。

   OAuth 認証

   ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。
4. Create & Test をクリックします。
5. 「Add Backlog Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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

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

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

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

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

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