PowerBuilder で Backlog OData フィードを利用

CData API Server は、PowerBuilder DataWindow で利用できるセキュアなBacklog のデータフィードを生成します。API Server は、OData、Atom、JSON、HTML、CSV、TSV、RSS などの主要な Web サービスをサポートしています。また、主要な認証スキームと SSL もサポートしています。

この記事では、CData API Server を使用して読み取りと書き込みを実行する DataWindow を作成する方法を説明します。

API Server のセットアップ

以下の手順に従って、セキュアな Backlog OData サービスの作成を開始します。

デプロイ

API Server は独自のサーバー上で実行されます。Windows では、スタンドアロンサーバーまたは IIS を使用してデプロイできます。Java サーブレットコンテナでは、API Server WAR ファイルをドロップします。詳細と手順については、ヘルプドキュメントを参照してください。

API Server は、Microsoft Azure、Amazon EC2、Heroku へのデプロイも簡単です。

Backlog への接続

API Server をデプロイしたら、API Server 管理コンソールで Settings -> Connections をクリックして新しい接続を追加し、Backlog に接続するために必要な認証値やその他の接続プロパティを指定します。

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

API キー認証

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

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

OAuth 認証

次に、Settings -> Resources をクリックして、API Server からアクセスを許可する Backlog エンティティを選択できます。

また、Settings -> Server をクリックし、PowerBuilder との互換性のために以下の設定を変更します：

• Default Format：メニューから XML (Atom) を選択。
• Default Version：メニューから 2.0 を選択。

API Server ユーザーの認可

生成する OData サービスを決定したら、Settings -> Users をクリックしてユーザーを認可します。API Server は Authtoken ベースの認証を使用し、主要な認証スキームをサポートしています。アクセスは IP アドレスに基づいて制限することもできます。デフォルトでは、ローカルマシンへの接続のみが許可されています。SSL で認証と接続の暗号化も可能です。

Backlog 用のプロファイルを作成

以下の手順に従って、Database Painter ツールを使用して API Server の OData API 用のデータベースプロファイルを作成します。Database Painter では、データをグラフィカルに操作したり、SQL クエリを実行したりできます。

1. Tools -> Database Painter をクリックします。
2. OData ノードを右クリックし、New Profile をクリックします。
3. Database Profile Setup ダイアログで、以下を入力します：
   • Profile Name：プロファイルのわかりやすい名前を入力します。
   • URI：API Server の OData エンドポイントへの URL を入力します。この URL は以下のような形式になります：

     http://MyServer:8080/api.rsc

   • Supply User Id and Password：HTTP Basic 認証を使用する場合は、このオプションをクリックします。なお、API Server は Windows 認証もサポートしています。
   • User Id：API Server のユーザー名を入力します。
   • Password：API Server のユーザーの Authtoken を入力します。
   
4. テーブルを表示・変更するには、テーブルを右クリックして Edit Data -> Grid をクリックします。

PowerBuilder コントロールで Backlog のデータ を使用

標準的な PowerBuilder オブジェクトを使用して OData フィードに接続し、クエリを実行できます。以下の例は、Backlog のデータ を DataWindow に取得する方法を示しています。

open メソッドに以下のコードを追加できます：

SQLCA.DBMS = "ODT"
SQLCA.DBParm = "ConnectString='URI=http://MyServer:8080/api.rsc;UID=MyAPIUser;PWD=MyAuthtoken'";
CONNECT USING SQLCA;
dw_issues.SetTransObject(SQLCA);
dw_issues.Retrieve();