OData SDK for PHP を使ってPipedrive のデータを取得

CData Connect Server を使えば、OData を使ってPipedrive のデータにアクセスできます。CData Connect Server とOData PHP SDK を利用することで、Pipedrive のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

加藤龍彦
デジタルマーケティング

最終更新日:2022-11-25

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Connect Server はPipedrive のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Pipedrive のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect Server はPipedrive のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からPipedrive のデータへのリアルタイム連携を実現します。

Pipedrive の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

  1. CData Connect Server にログインして、「DATA MODEL」をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"Pipedrive" を選択します。
  3. 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
      • AuthSchemeBasic
    3. 承認されたユーザー名とパスワードでログインします。

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

    OAuth 認証

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

    接続を設定

  4. 「Test Connection」をクリックします。
  5. 「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
  6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

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

  1. まずは、ODataPHP SDK を使用してCData Connect Server が公開したWeb サービスに接続するプロキシクラスを作成します。

    URI 部分を書き換えて、次のようなコマンドを実行してください。

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

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

    CData Connect Server およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect Server はOData エンドポイントへのアクセスが認可されたユーザーの認証に、認証トークンを使用します。認証トークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

    認証済みのユーザーは、CData Connect Server の管理コンソールのUsers セクションで設定できます。

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

    require_once 'PipedriveEntities.php'; try{ $svc = new CDataAPI(); $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) { //CData Connect Server からのエラーをキャッチ echo $e->getError(), "\n"; }

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。