PowerBuilder で Webflow OData フィードを利用

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

この記事では、CData API Server を使用してデータを取得する DataWindow を作成する方法を説明します。

API Server のセットアップ

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

デプロイ

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

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

Webflow への接続

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

認証

Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。

OAuth 2.0 のセットアップと設定

ステップ 1：Webflow OAuth アプリケーションの作成

OAuth 認証をセットアップするには、以下のステップで進めます：

1. Webflow Developer Portal にアクセスします
2. Webflow アカウントの「Apps & Integrations」に移動します
3. 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
4. アプリケーション名、説明、リダイレクト URI（CallbackURL）を設定します
5. 接続で使用する Client ID と Client Secret をコピーします

必須の接続プロパティ

• AuthScheme：OAuth に設定します（必須）
• OAuthClientId：Webflow OAuth アプリケーションの Client ID（必須）
• OAuthClientSecret：Webflow OAuth アプリケーションの Client Secret（必須）
• CallbackURL：OAuth アプリケーションで指定したリダイレクト URI（必須）
• InitiateOAuth：トークンを自動管理するには GETANDREFRESH に設定します（推奨）

必須の OAuth スコープ

Webflow API プロファイルでは、以下の OAuth スコープが必要です：

• sites:read - サイト情報および設定への読み取りアクセス
• pages:read - サイトページへの読み取りアクセス
• cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
• forms:read - フォームおよびフォーム送信への読み取りアクセス
• assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
• ecommerce:read - 製品、注文、在庫への読み取りアクセス
• authorized_user:read - 認可されたユーザーへの読み取りアクセス

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

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

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

API Server ユーザーの認可

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

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

以下の手順に従って、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 コントロールで Webflow のデータ を使用

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

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

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