Slingshot からPipedrive のデータに接続するバックエンドAPI をノーコードで開発

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

CData API Server を使って、Slingshot から Pipedrive に接続してダッシュボードを作成する方法を説明します。

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 の無償トライアルをスタートしたら、セキュアなPipedrive OData サービスを作成していきましょう。

デプロイ

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

Pipedrive への接続

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

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

5. 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 認証」セクションを参照してください。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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

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

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 認証」セクションを参照してください。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

Slingshot にデータソースを追加する

CData API Server の設定が完了したら、Slingshot 側に接続設定を追加しましょう。

1. Slingshot の対象のワークスペースに移動して「データソース」タブに移動し「＋データソース」をクリックします。

2. データソースの一覧から利用したいサービスを選択します。ここで先程CData API Server で設定したOData エンドポイントの接続を追加します。

3. 「URL」にOData エンドポイントのURL を指定し「先制認証を使用する」にチェックを入れます。その上で「資格情報」を追加しましょう。

4. 資格情報の種類は「汎用資格情報」になります。合わせてCData API Server のユーザー名を入力し、パスワードには先程生成したトークンを入力します。

5. あとは「データソースの追加」をクリックすれば、データソースの接続設定は完了になります。

ダッシュボードを作成する

すべての準備が整ったのでPipedrive のデータを活用してダッシュボードを作成していきましょう。

1. 「ダッシュボード」タブに移動して「＋ダッシュボード」をクリックします。

2. 先程追加したCData API Server へのOData フィードデータソースが表示されるので、これを選択します。

3. すると、事前にCData API Server 上で登録しておいたテーブルの一覧がエンティティのセットとして表示されるので、任意のエンティティを選択しましょう。

4. これでSlingshot 上に対象のデータがシームレスに読み込まれます。あとは可視化するためのラベルや値を選択することで、以下のように簡単にビジュアライズが実施できます。

まとめと30日の無償評価版のご案内

このように Pipedrive 内のデータをSlingshot で利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、Slingshot からのデータ参照を体感ください。