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

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

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

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

API Server の設定

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

Jira Service Management への接続

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

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

任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。
- URL（例：https://yoursitename.atlassian.net）
カスタムフィールドへのアクセス

デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。
Jira Service Management への認証

ベーシック認証

ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。
- AuthScheme：Basic に設定。
- User：認証ユーザーのユーザー名に設定。
- Password：認証ユーザーのパスワードに設定。
API トークン

Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

データに接続するには以下を設定します。
- AuthScheme：APIToken に設定。
- User：認証ユーザーのユーザー名に設定。
- APIToken：作成したAPI トークンに設定。
ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

OAuth 2.0
Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。
この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Jira Service Management 接続プロパティの取得・設定方法

任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

URL（例：https://yoursitename.atlassian.net）

カスタムフィールドへのアクセス

デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

Jira Service Management への認証

ベーシック認証

ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

AuthScheme：Basic に設定。
User：認証ユーザーのユーザー名に設定。
Password：認証ユーザーのパスワードに設定。

API トークン

Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

データに接続するには以下を設定します。

AuthScheme：APIToken に設定。
User：認証ユーザーのユーザー名に設定。
APIToken：作成したAPI トークンに設定。

ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

OAuth 2.0

Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

API Server のユーザー設定

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

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

Jira Service Management 用のAPI エンドポイントの作成

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

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

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

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

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

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

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

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

ブラウザより Monaca のダッシュボードを開き、「新しいプロジェクトを作る」をクリックします。

まずはテンプレートの種類は、フレームワークテンプレートを選択します。

今回は JavaScript を選択します。

テンプレートは「Onsen UI V2 JS Navigation」を選択します。テンプレの画面構成は、「Push page」ボタンをクリックすると、画面遷移するものとなっています。

任意のプロジェクト名を設定し、「作成」ボタンをクリックします。

作成したプロジェクトを選択した状態で、「クラウドIDEで開く」をクリックします。

検索ボタンがクリックされたら、先ほど作成した API を Ajax で呼び出すようにしています。

API Server で作成したエンドポイントをURL に設定し、ヘッダーにAPI Server のアクセストークンを設定します。
レスポンスが返ってきた後、処理が成功していればリストにname だけを1データずつ加えています。