Node.js からKlaviyo のデータをクエリ
CData API Server とADO.NET Provider for Klaviyo(もしくは250+ の他のADO.NET Providers)を使って、Klaviyo をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたKlaviyo のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなKlaviyo OData サービスを作成していきましょう。
Klaviyo への接続
NodeJS からKlaviyo のデータを操作するには、まずKlaviyo への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Klaviyo」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Klaviyo への接続設定を行っていきましょう！
-
Klaviyo に認証するには、API キーを取得します。API キーは「My Account」から生成・確認できます。
- 「Settings」>「API Keys」に移動します。
- 「Create API Key」をクリックします。
- API キーに名前を付け、必要なスコープを選択します。
CData 製品から接続するには、API Key に取得した Klaviyo API キーを設定してください。
OAuth 認証を使用する場合は、ヘルプドキュメントをご参照ください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Klaviyo に認証するには、API キーを取得します。API キーは「My Account」から生成・確認できます。
- 「Settings」>「API Keys」に移動します。
- 「Create API Key」をクリックします。
- API キーに名前を付け、必要なスコープを選択します。
CData 製品から接続するには、API Key に取得した Klaviyo API キーを設定してください。
OAuth 認証を使用する場合は、ヘルプドキュメントをご参照ください。
API Server のユーザー設定
次に、API Server 経由でKlaviyo にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Klaviyo 用のAPI エンドポイントの作成
ユーザーを作成したら、Klaviyo のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でKlaviyo への接続を設定してユーザーを作成し、API Server でKlaviyo データのAPI を追加しました。これで、OData 形式のKlaviyo データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
Node.js からKlaviyo OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはCampaigns データに対して認証されたリクエストを行います。 以下のURL の例では、Status カラムの値がdraft のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Campaigns?$filter=" + encodeURIComponent("Status eq 'draft'"),
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);
});