ローコードアプリ開発プラットフォームOutSystems でPipedrive 連携アプリを作成

杉本和也
リードエンジニア

CData API Server を使ってPipedrive のデータの仮想OData API エンドポイントを作成して、OutSystems からPipedrive のデータを使ったアプリを作成する方法。

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData API Server を経由して OutSystems からPipedrive に連携するアプリを作成する方法を説明します。

CData API Server は、Pipedrive のデータのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにPipedrive のデータへ連携することができます。さらに、CData API Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。

API Server の設定

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

Pipedrive への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Pipedrive」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Pipedrive への接続設定を行っていきましょう！
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 認証」セクションを参照してください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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

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

Basic 認証

Basic 認証で認証するには：

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

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

OAuth 認証

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

API Server のユーザー設定

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

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

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

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

まず、「API」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ（https://myserver/api.rst#oas）にある「Open API」のファイルを以下から保存しておきましょう。

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

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