Mule アプリケーションからPipedrive のデータにアクセス：CData JDBC Driver

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for Pipedrive はPipedrive のデータをMule アプリケーションと連携することで、読み、書き、更新、削除といった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、Pipedrive のデータをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。

本記事では、Mule プロジェクト内でCData JDBC Driver for Pipedrive を使用して、Pipedrive のデータのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でPipedrive のデータをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで250 を超えるデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。

1. Anypoint Studio で新しいMule プロジェクトを作る。
2. Message Flow にHTTP コネクタを追加する。
3. HTTP コネクタのアドレスを設定する。
4. HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
5. データベースへの新しい接続を作成し（または既存の接続を編集し）、プロパティを設定する。
   • 接続を「Generic Connection」に設定
   • Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例：cdata.jdbc.pipedrive.jar)。
   • Pipedrive の接続文字列にURL を指定

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

     Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

     Basic 認証

     Basic 認証で認証するには：
     1. API トークンを取得します。
        1. Pipedrive ポータルを開きます。
        2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
        3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
        4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
     2. 次の接続プロパティを設定します。
        • APIToken：取得したAPI トークンの値。
        • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
        • AuthScheme：Basic。
     3. 承認されたユーザー名とパスワードでログインします。

     API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

     OAuth 認証

     ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth 認証」セクションを参照してください。

     組み込みの接続文字列デザイナ

     JDBC 用のURL の作成にサポートが必要な場合は、Pipedrive JDBC Driver に組み込まれた接続文字列デザイナを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行してください。

     java -jar cdata.jdbc.pipedrive.jar

     接続プロパティを入力して、接続文字列をクリップボードにコピーします。

   • Driver クラス名をcdata.jdbc.pipedrive.PipedriveDriver に指定します。
   • 「接続テスト」をクリックします。
6. SQL Query Text をPipedrive のデータをリクエストするためのSQL クエリに設定します。例えば、SELECT PersonName, UserEmail FROM Deals WHERE Value > 50000。
7. Transform Message コンポーネントをフローに追加します。
8. Output スクリプトを次のように設定して、ペイロードをJSON に変換します。

   %dw 2.0
   output application/json
   ---
   payload
           

9. Pipedrive のデータを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します（デフォルトでは、localhost:8081）：http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、Pipedrive のデータをJSON として利用できます。

これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからPipedrive のデータを（JSON データとして）扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for Pipedrive の30日の無償評価版のダウンロードはこちらから。