Node.js からKintone のデータをクエリ

加藤龍彦
デジタルマーケティング

API Server は、データを外部に公開します。CData API Server のOData エンドポイントを使って、Node.js からKintone へのCRUD クエリを実行します。

CData API Server とADO.NET Provider for Kintone(もしくは250+ の他のADO.NET Providers)を使って、Kintone をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたKintone のデータをNode.js でリクエストする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなKintone OData サービスを作成していきましょう。

Kintone への接続

NodeJS からKintone のデータを操作するには、まずKintone への接続を作成・設定します。

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Kintone」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Kintone への接続設定を行っていきましょう！
Kintone 接続プロパティの設定方法

それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。
- URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
- User：アカウントのユーザー名
- Password：アカウントのパスワード
- AuthScheme：「Password」を指定
パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

Basic 認証の設定

続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。
- BasicAuthUser：Basic 認証のユーザー名
- BasicAuthPassword：Basic 認証のパスワード
クライアント証明書認証の設定

Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。
- SSLClientCert：クライアント証明書のパス
- SSLClientCertType：証明書の種類
- SSLClientCertSubject：証明書のサブジェクト
- SSLClientCertPassword：証明書のパスワード
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Kintone 接続プロパティの設定方法

それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
User：アカウントのユーザー名
Password：アカウントのパスワード
AuthScheme：「Password」を指定

パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

Basic 認証の設定

続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

BasicAuthUser：Basic 認証のユーザー名
BasicAuthPassword：Basic 認証のパスワード

クライアント証明書認証の設定

Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

SSLClientCert：クライアント証明書のパス
SSLClientCertType：証明書の種類
SSLClientCertSubject：証明書のサブジェクト
SSLClientCertPassword：証明書のパスワード

API Server のユーザー設定

次に、API Server 経由でKintone にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Kintone 用のAPI エンドポイントの作成

ユーザーを作成したら、Kintone のデータ用のAPI エンドポイントを作成していきます。

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でKintone への接続を設定してユーザーを作成し、API Server でKintone データのAPI を追加しました。これで、OData 形式のKintone データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Node.js からKintone OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはApps データに対して認証されたリクエストを行います。以下のURL の例では、AppId カラムの値が1354841 のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Apps?$filter=" + encodeURIComponent("AppId eq '1354841'"),
  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);
});

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

Node.js からKintone のデータをクエリ

API Server の設定