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

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

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

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

Connect AI を構成

ODataPHP SDK でHubSpot のデータを操作するには、Connect AI からHubSpot に接続し、コネクションにユーザーアクセスを提供してHubSpot のデータのOData エンドポイントを作成する必要があります。

HubSpot に接続したら、目的のテーブルのOData エンドポイントを作成します。

(オプション)新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でHubSpot に接続するユーザーを作成します。

  1. 「Users」ページに移動し、 Invite Users をクリックします。
  2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。 新しいユーザーを招待
  3. 「Users」ページからユーザーを確認および編集できます。 Connect AI ユーザー

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

  1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
  2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
  3. PAT の名前を入力して Create をクリックします。 Creating a new PAT
  4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からHubSpot に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、 Add Connection をクリックします。 コネクションの追加
  2. 「Add Connection」パネルから「HubSpot」を選択します。 データソースの選択
  3. 必要な認証プロパティを入力し、HubSpot に接続します。

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

    HubSpot はOAuth 認証 およびPrivateAppToken ベース認証をサポートします。

    OAuth

    HubSpot は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーションまたはヘッドレスマシンから簡単に接続できます。 Web アプリケーションから接続するには、カスタムOAuth アプリケーションを作成する必要があります。 OAuth 経由で接続するには、すべての認証フローでAuthSchemeOAuth に設定します。 ヘルプドキュメントでは、利用可能なOAuth フローでのHubSpot への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、「カスタムOAuth アプリケーションの作成」セクション を参照してください。

    また、PrivateAppToken ベース認証についてはヘルプドキュメントの「接続の確立」セクションを参照してください。

    接続の設定(Salesforce の表示)
  4. Create & Test をクリックします。
  5. 「Add HubSpot Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

Connect AI にHubSpot OData エンドポイントを追加する

HubSpot に接続したら、目的のテーブルのOData エンドポイントを作成します。

  1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
  2. HubSpot 接続(例:HubSpot1)を選択し、Next をクリックします。
  3. 使用するテーブルを選択し、「Confirm」をクリックします。 テーブルを選択(Salesforce の例)

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

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

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

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\HubSpotEntities.php
    	    

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

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

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

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

    require_once 'HubSpotEntities.php';
    try{
      $svc = new CDataAPI();
      $prospects = new Prospects();
      $prospects->Region = 'ONTARIO';
      $svc->AddToProspects($prospects);
      $svc->SetSaveChangesOptions(SaveChangesOptions::None);
      $svc->SaveChanges();
      $response = $svc->prospects()->Execute();
      foreach($response->Result as $prospects)
        echo $prospects->Slug."";
    } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
      echo $e->getError(), "\n";
    }
    

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

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル お問い合わせ