PHP のOData SDK を使用したPipedrive のデータのクエリ

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でPipedrive エンティティを手軽に使用。



CData API Server は、ADO.NET Provider for Pipedrive（またはその他の250+ ADO.NET Providers のデータ）と組み合わせることでWeb サービスとしてPipedrive のデータを公開します。下記の手順に従って、Pipedrive のデータをオブジェクトとして使用します。

API Server の設定

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

Pipedrive への接続

PHP から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 認証

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 のエンドポイントを表示およびコピーできます。

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

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。 

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

  • Windows：C:\ProgramData\CData\Pipedrive\
  • Unix or Mac OS X：~/cdata/Pipedrive/

Pipedrive エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

  1. 以下のようなコマンドにURL を渡します。 

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\PipedriveEntities.php

    上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

    API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

    許可されたユーザーは、API Server の「Users」セクションで設定できます。

  2. PHP のオブジェクト指向インターフェースを使用して、Pipedrive のデータへのアクセスを開始できます。以下のコードは、Deals テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。 

    require_once 'PipedriveEntities.php';
try{
  $svc = new CData();
  $deals = new Deals();
  $deals->Value = '50000';
  $svc->AddToDeals($deals);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->deals()->Execute();
  foreach($response->Result as $deals)
    echo $deals->PersonName."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事