Node.js からWebflow のデータをクエリ
CData API Server とADO.NET Provider for API(もしくは240+ の他のADO.NET Providers)を使って、Webflow をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたWebflow のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなWebflow OData サービスを作成していきましょう。
Webflow への接続
NodeJS からWebflow のデータを操作するには、まずWebflow への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Webflow」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Webflow への接続設定を行っていきましょう!
-
認証
Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。
OAuth 2.0 のセットアップと設定
ステップ 1:Webflow OAuth アプリケーションの作成
OAuth 認証をセットアップするには、以下のステップで進めます:
- Webflow Developer Portal にアクセスします
- Webflow アカウントの「Apps & Integrations」に移動します
- 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
- アプリケーション名、説明、リダイレクト URI(CallbackURL)を設定します
- 接続で使用する 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 - 認可されたユーザーへの読み取りアクセス
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
認証
Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。
OAuth 2.0 のセットアップと設定
ステップ 1:Webflow OAuth アプリケーションの作成
OAuth 認証をセットアップするには、以下のステップで進めます:
- Webflow Developer Portal にアクセスします
- Webflow アカウントの「Apps & Integrations」に移動します
- 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
- アプリケーション名、説明、リダイレクト URI(CallbackURL)を設定します
- 接続で使用する 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 - 認可されたユーザーへの読み取りアクセス
API Server のユーザー設定
次に、API Server 経由でWebflow にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Webflow 用のAPI エンドポイントの作成
ユーザーを作成したら、Webflow のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でWebflow への接続を設定してユーザーを作成し、API Server でWebflow データのAPI を追加しました。これで、OData 形式のWebflow データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からWebflow OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはSites データに対して認証されたリクエストを行います。 以下のURL の例では、Id カラムの値がyour_site_id のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Sites?$filter=" + encodeURIComponent("Id eq 'your_site_id'"),
auth:'MyUser:MyAuthtoken'
},
function(res) {
var body = '';
res.on('data', function(chunk) {
body += chunk;
});
res.on('end', function() {
console.log(body);
var jsonData = JSON.parse(body);
});
}).on('error', function(e) {
console.log("Error: ", e);
});