Monaca アプリで使えるConfluence のデータ連携用のバックエンドAPI をノーコードで開発

ハイブリッドアプリ開発プラットフォームMonaca から Confluence のデータに接続するためのバックエンドAPI サーバーをCData API Server で構築

宮本航太
プロダクトスペシャリスト

最終更新日:2022-05-15

この記事で実現できるConfluence 連携のシナリオ

こんにちは!プロダクトスペシャリストの宮本です。

CData API Server と ADO.NET Provider for Confluence を使って、Monaca ハイブリッドアプリ開発プラットフォーム(https://ja.monaca.io/) から Confluence に接続してデータを取得する方法を説明します。

API Server の設定

次のステップに従い、セキュアな REST API サービスを立ち上げます

デプロイ

API Server はサーバー上で稼働します。Windows 版は、製品に組み込まれているスタンドアロンのサーバーかIIS に配置して稼働させることができます。Java 版では、Java servlet コンテナにAPI Server のWAR ファイルを配置します。 デプロイの詳細は製品ヘルプを参照してください。API Server を Microsoft AzureAmazon EC2Heroku にデプロイする方法はKB に記事があります。

Confluence への接続

API Server の管理コンソールで[設定]→[接続]から新しい接続を追加してConfluence を追加します。

Confluence のアイコンがデフォルトのAPI Server の接続先にない場合には、API Server がJava 版の場合はJDBC Drivers、API Server がWindows 版の場合はADO.NET Data ProvidersからConfluence ドライバーをAPI Server と同じマシンにインストールして、API Server を再起動します。

Confluence への接続に必要な認証情報を入力します。接続のテストを行い、接続を確認して、設定を保存します。

Confluence 接続プロパティの取得・設定方法

任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

Confluence への認証

Confluence は、次の認証メソッドをサポートしています:API トークン、Basic 認証、OAuth 2.0、SSO。

API トークン - Confluence Cloud アカウント

トークンの取得

アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

トークンを使用する認証

Cloud アカウントへの認証を行うには、以下を入力します。

  • AuthScheme:APIToken に設定。
  • User:Confluence サーバーに認証する際に使用されるユーザー。
  • APIToken:現在認証されているユーザーに紐づくAPI トークン。
  • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

Basic 認証 - Confluence Server インスタンス

Server インスタンスへの認証を行うには、以下のように指定します。

  • AuthSchemeBasic に設定。
  • User:Confluence インスタンスに認証する際に使用されるユーザー。
  • Password:Confluence サーバーに認証する際に使われるパスワード。
  • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

  • 接続を確立後、[設定]→[リソース]の画面でテーブル一覧からREST API として公開するエンティティを選択します。
  • API Server のユーザー設定

    [設定]→[ユーザー]からAPI にアクセスできるユーザーの認証設定を行います。API Server はトークンでの認証を行うことができます。 IP アドレスでAPI へのアクセスを制限することも可能です。デフォルトではローカルマシンからのアクセスのみが許可されています。SSL の設定も可能です。

    オンプレミスDB やファイルからのAPI Server 使用(オプション)

    オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。

    Monaca で作成したモバイルアプリでの Confluence のデータ取得

    Monacaではクラウド上にあるIDEが用意されていますので、まずはアカウント作成します。そこからCData API Server のデータをMonaca アプリ使う設定を作成していきます。

    1. ブラウザより Monaca のダッシュボードを開き、「新しいプロジェクトを作る」をクリックします。
    2. Monaca
    3. まずはテンプレートの種類は、フレームワークテンプレートを選択します。
    4. Monaca
    5. 今回は JavaScript を選択します。
    6. Monaca
    7. テンプレートは「Onsen UI V2 JS Navigation」を選択します。テンプレの画面構成は、「Push page」ボタンをクリックすると、画面遷移するものとなっています。
    8. Monaca
    9. 任意のプロジェクト名を設定し、「作成」ボタンをクリックします。
    10. Monaca
    11. 作成したプロジェクトを選択した状態で、「クラウドIDEで開く」をクリックします。
    12. Monaca
    13. 検索ボタンがクリックされたら、先ほど作成した API を Ajax で呼び出すようにしています。
      Monaca
      API Server で作成したエンドポイントをURL に設定し、ヘッダーにAPI Server のアクセストークンを設定します。
      Monaca
    14. レスポンスが返ってきた後、処理が成功していればリストにname だけを1データずつ加えています。

    デバッグ実行してみる

    Monaca でデバッグを行う際は、Monacaデバッガーアプリを実機にインストールすることで、MonacaのクラウドIDE と実機で動かしているMonacaデバッガーアプリが連動するようです。そのため、いちいちコードを修正してからのビルドが不要になるため、素早く検証を行うことができます。

    また、Monaca Localkit を使うことで、ローカルの開発環境でも利用することができます。今回はこのLocalkit を使って vscode 上でコードを修正し、アプリ内容を確認していきました。

    Monaca Localkit を起動し、プレビューを押すとすぐにアプリ画面が表示されます。

    Monaca

    初期画面→検索→画面遷移まで確認することができました。

    Monaca

    このように Confluence 内のデータをMonaca アプリで利用することができるようになります。

    トライアル・お問い合わせ

    30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。