Node.js からConfluence Data をクエリ

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

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

Set Up the API Server

Follow the steps below to begin producing secure Confluence OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Confluence

After you deploy the API Server and the ADO.NET Provider for Confluence, provide authentication values and other connection properties needed to connect to Confluence by clicking Settings -> Connections and adding a new connection in the API Server administration console.

API Token を取得する方法

API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

Confluence Cloud Account への接続

Cloud アカウントへの接続には、以下のプロパティを設定します(Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。):

  • User: Confluence サーバーに認証するユーザー名。
  • APIToken: 認証するユーザーに紐付けられたAPI Token。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

Confluence Server Instance への接続

Server instance への接続には以下を設定します:

  • User: Confluence Instance に接続するユーザー名。
  • Password: Confluence Instance に接続するユーザーのパスワード。
  • Url: JIRA エンドポイントのURL。例: https://yoursitename.atlassian.net

You can then choose the Confluence entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; all IP addresses except the local machine are restricted by default. You can authenticate as well as encrypt connections with SSL.

Consume Confluence OData Feeds from Node.js

OData feeds are easy to work with in Node.js. You can use the HTTP client in Node.js to request JSON-formatted data from the API Server's OData endpoint. After making the request, you can construct the body of the response and call the JSON.parse() function to parse it into records.

The code below will make an authenticated request for Pages data. The example URL below applies a simple filter that searches for records with a value of 10000 in the Id column.

var http = require('http'); http.get({ protocol: "http:", hostname: "MyServer.com", port: MyPort, path: "/api.rsc/Pages?$filter=" + encodeURIComponent("Id eq '10000'"), 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); });
 
 
ダウンロード