Azure App サービスでBacklog のIFTTT フローをトリガー

こんにちは！リードエンジニアの杉本です。

Azure Logic Apps は ノーコードでアプリを構築できるクラウドサービスです。CData API Server と連携することで、ノーコードアプリ開発用のBacklog のデータへのクラウドベースのアクセスをノーコードで追加できます。本記事では、API Server 経由でAzure Logic Apps からBacklog 連携を実現する方法を紹介します。

CData API Server とは？

CData API Server は、以下のような特徴を持ったAPI 開発ツールです。

• あらゆるデータソースからAPI を生成：SQL Server、MySQL、Oracle、PostgreSQL、DB2 などのRDB、Excel、CSV、Google スプレッドシートなどCData の充実したコネクタライブラリを利用できます。
• 主要なデータ形式に対応：OData、REST、JSON、CSV / TSV など、主要な形式に対応しています。
• 一元管理でAPI を効率運用：単一の管理プラットフォーム上でAPI の更新、停止、共有が可能です。
• ノーコードでシンプルな設定：GUI ベースのインターフェースを使用して、複雑なコーディングなしでAPI を作成・セキュアに公開できます。

詳しくは、こちらの製品資料をご確認ください。

API Server の設定

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

デプロイ

API Server は内蔵のJetty サーバー上で動作します。Windows をお使いの場合は、スタンドアロンサーバーとして起動するか、IIS に組み込んで使用することが可能です。また、お使いのJava サーブレットコンテナにAPI Server のWAR ファイルを配置して実行することもできます。具体的なセットアップ方法については、こちらのヘルプドキュメントをご覧ください。

Backlog への接続

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

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

5. Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

   API キー認証

   ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

   1. Backlog の個人設定ページを開きます。
   2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
   3. ApiKey にAPI キーを指定します。
   4. URL はBacklog のテナントURL から取得できます。

   OAuth 認証

   ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

1. Backlog の個人設定ページを開きます。
2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
3. ApiKey にAPI キーを指定します。
4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

API Server のユーザー設定

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

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

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

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

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

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

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

コネクションとOData エンドポイントを設定したら、Azure Logic Apps からBacklog のデータに接続できます。

Logic App でBacklog にアクセス

Logic App でAPI Server を使用し、Backlog の周りにプロセスフローを作成できます。HTTP + Swagger アクションは、Backlog に対して実行する操作を定義するためのウィザードを提供します。以下のステップでは、Logic App でBacklog を取得する方法を説明しています。

テーブルにレコードの作成日を含むカラムがある場合は、以下のステップに従って新しいレコードのカラム値をチェックする関数を作成できます。それ以外の場合は、［Create a Logic App］セクションにスキップし、フィルタに一致するエンティティにメールを送信します。

新しいBacklog エンティティを確認

特定の新しいBacklog エンティティを見つけるために、インターバルの開始日時の値を取得する関数を作成できます。

1. ［Azure Portal］で、［New］->［Function App］->［Create］と進みます。
2. 名前を入力し、サブスクリプション、リソースグループ、App Service プラン、そしてストレージアカウントを選択します。
3. Function App を選択し、Webhook + API シナリオを選択します。
4. 言語を選択します。この記事では、JavaScript を使用します。
5. 以下のコードを追加し、JSON オブジェクトで前の時間を返します。

   module.exports = function (context, data) {
     var d = new Date();
     d.setHours(d.getHours()-1);
     // Response of the function to be used later.
     context.res = {
       body: {
         start: d
       }
     };
     context.done();
   };
   

トリガーにBacklog を追加

以下のステップに従って、フィルタに一致する結果をBacklog で検索するトリガーを作成します。上記の関数を作成した場合は、返されたインターバルの開始後に作成されたオブジェクトを検索できます。

1. Azure Portal で［New］をクリックし、［Web + Mobile］セクションで［Logic App］を選択してリソースグループとApp Service プランを選択します。
2. これで、Logic App Designer で使用可能なウィザードが使用できます。このウィザードには、Logic App の設定ブレードからアクセスできます。Blank Logic App templateを選択します。
3. Backlog オブジェクトをポーリングするRecurrence アクションを追加します。この記事では、一時間ごとにポーリングします。タイムゾーンを選択します。デフォルトはUTC です。
4. 関数アクションを追加します。［Add Action］ダイアログのメニューを展開し、リジョンにAzure 関数を表示するオプションを選択します。先に作成したFunction App を選択し、インターバル開始を返す関数を選択します。
5. からの中括弧のペア（{}）を入力し、からのペイロードオブジェクトを関数に渡します。
6. HTTP + Swagger アクションを追加し、API Server のOData エンドポイントを入力します。 http://MySite:MyPort/api.rsc/@MyAuthtoken/$oas
7. ［Return Issues］操作を選択します。

8. 各プロパティの説明を使用して、取得する列やフィルターなどの追加パラメータを指定します。以下はフィルタの一例です。

   Id eq '1'

9. getInterval 関数から返された日時値を使用するには、Issues テーブルの日時列で［ge］演算子を使用し、ダイアログでBody パラメータを選択します。日時値を囲むには、クォーテーションを使用する必要があることに注意して下さい。

   

10. ［Code View］に切り替え、$filter 式を変更してインターバルの開始を含むプロパティを抽出します。'@{body('MyFunc')['MyProp']' 構文を使用します。

    "getAllAccount": {
      "inputs": {
        "method": "get",
          "queries": {
            "$filter":"CreatedDate ge '@{body('getInterval')['start']}'"
          },
          "uri": "https://MySite:MyPort/api.rsc/@MyAuthtoken/Issues"
      }
    

これで、ワークフローのデータソースおよび宛先としてBacklog にアクセスできます。

新しレコードをメールで送信

以下のステップに従って、新しいIssues エンティティを含むレポートをメールで送信します。

1. ［Logic Apps Designer］で［SMTP - Send Email］アクションを追加します。
2. SMTP サーバーに必要な情報を構成します。
3. From、To、Subject、Body を構成します。返されたBacklog 列からパラメータを追加できます。

［Save］をクリックし、［Run］をクリックして過去一時間に作成されたBacklog レコードに関する電子メール通知を送信します。

クラウドアプリケーションからBacklog のデータへのライブ接続

Azure Logic Apps からBacklog のリアルタイムデータに直接接続できるようになりました。これで、Backlog のデータを複製せずにより多くの接続とアプリを作成できます。

クラウドアプリケーションから直接100を超えるSaaS 、ビッグデータ、NoSQL ソースへのリアルタイムデータアクセスを取得するには、API Server を参照してください。