PHP のOData SDK を使用したMonday.com のデータのクエリ

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



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

API Server の設定

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

Monday.com への接続

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

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

  5. Monday 接続プロパティの取得・設定方法

    Monday AuditLog API

    Monday AuditLog API は、API トークンによる認証のみをサポートしています。

    監査ログAPI トークンを生成するには：

    1. monday.com アカウントにログインします。
    2. 画面右上のアバター（画像アイコン）をクリックします。
    3. 表示されたメニューからAdministration を選択します。
    4. 左側のナビゲーションでSecurity をクリックします。
    5. Audit タブをクリックします。
    6. Monitor by API -> Copy をクリックして、AuditLog API トークンをコピーします。

    API トークンを取得した後、以下の接続プロパティを設定します。

    • Schema："AuditLog" に設定。
    • AuthScheme：Token
    • APIToken：取得した監査ログAPI トークン
    • URL：Monday アカウントURL。ログイン後、自身のMonday ホームページのURL をコピーできます。例：https://your-account-name.monday.com/。

    Monday GraphQL API

    Monday GraphQL API は、API トークンまたはOAuth 標準による認証をサポートしています。

    API トークン

    API トークンで接続するには、AuthScheme をToken に設定し、次の手順でAPIToken を取得します。

    1. monday.com アカウントにログインします。
    2. 画面右上のアバター（画像アイコン）をクリックします。
    3. 表示されたメニューからAdministration を選択します（管理者権限が必要です）。
    4. 左側のナビゲーションでConnections をクリックし、表示されたページでAPI タブをクリックします。
    5. Personal API Token で、Create token をクリックしてパーソナルAPI トークンを作成します。APIToken 接続プロパティをこの値に設定します。
      • すでにトークンを作成している場合は、Personal API Token でCopy ボタンをクリックしてAPI トークンをコピーします。APIToken 接続プロパティをこの値に設定します。

    OAuth で認証する場合は、ヘルプドキュメントの「OAuth 認証の使用」セクションを参照してください。

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

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

Monday AuditLog API

Monday AuditLog API は、API トークンによる認証のみをサポートしています。

監査ログAPI トークンを生成するには：

  1. monday.com アカウントにログインします。
  2. 画面右上のアバター（画像アイコン）をクリックします。
  3. 表示されたメニューからAdministration を選択します。
  4. 左側のナビゲーションでSecurity をクリックします。
  5. Audit タブをクリックします。
  6. Monitor by API -> Copy をクリックして、AuditLog API トークンをコピーします。

API トークンを取得した後、以下の接続プロパティを設定します。

  • Schema："AuditLog" に設定。
  • AuthScheme：Token
  • APIToken：取得した監査ログAPI トークン
  • URL：Monday アカウントURL。ログイン後、自身のMonday ホームページのURL をコピーできます。例：https://your-account-name.monday.com/。

Monday GraphQL API

Monday GraphQL API は、API トークンまたはOAuth 標準による認証をサポートしています。

API トークン

API トークンで接続するには、AuthScheme をToken に設定し、次の手順でAPIToken を取得します。

  1. monday.com アカウントにログインします。
  2. 画面右上のアバター（画像アイコン）をクリックします。
  3. 表示されたメニューからAdministration を選択します（管理者権限が必要です）。
  4. 左側のナビゲーションでConnections をクリックし、表示されたページでAPI タブをクリックします。
  5. Personal API Token で、Create token をクリックしてパーソナルAPI トークンを作成します。APIToken 接続プロパティをこの値に設定します。
    • すでにトークンを作成している場合は、Personal API Token でCopy ボタンをクリックしてAPI トークンをコピーします。APIToken 接続プロパティをこの値に設定します。

OAuth で認証する場合は、ヘルプドキュメントの「OAuth 認証の使用」セクションを参照してください。

API Server のユーザー設定

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

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

Monday.com 用のAPI エンドポイントの作成

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

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

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

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

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

Monday AuditLog API

Monday AuditLog API は、API トークンによる認証のみをサポートしています。

監査ログAPI トークンを生成するには：

  1. monday.com アカウントにログインします。
  2. 画面右上のアバター（画像アイコン）をクリックします。
  3. 表示されたメニューからAdministration を選択します。
  4. 左側のナビゲーションでSecurity をクリックします。
  5. Audit タブをクリックします。
  6. Monitor by API -> Copy をクリックして、AuditLog API トークンをコピーします。

API トークンを取得した後、以下の接続プロパティを設定します。

  • Schema："AuditLog" に設定。
  • AuthScheme：Token
  • APIToken：取得した監査ログAPI トークン
  • URL：Monday アカウントURL。ログイン後、自身のMonday ホームページのURL をコピーできます。例：https://your-account-name.monday.com/。

Monday GraphQL API

Monday GraphQL API は、API トークンまたはOAuth 標準による認証をサポートしています。

API トークン

API トークンで接続するには、AuthScheme をToken に設定し、次の手順でAPIToken を取得します。

  1. monday.com アカウントにログインします。
  2. 画面右上のアバター（画像アイコン）をクリックします。
  3. 表示されたメニューからAdministration を選択します（管理者権限が必要です）。
  4. 左側のナビゲーションでConnections をクリックし、表示されたページでAPI タブをクリックします。
  5. Personal API Token で、Create token をクリックしてパーソナルAPI トークンを作成します。APIToken 接続プロパティをこの値に設定します。
    • すでにトークンを作成している場合は、Personal API Token でCopy ボタンをクリックしてAPI トークンをコピーします。APIToken 接続プロパティをこの値に設定します。

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\Monday\
  • Unix or Mac OS X：~/cdata/Monday/

Monday.com エンティティを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\MondayEntities.php

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

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

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

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

    require_once 'MondayEntities.php';
try{
  $svc = new CData();
  $invoices = new Invoices();
  $invoices->Status = 'SENT';
  $svc->AddToInvoices($invoices);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->invoices()->Execute();
  foreach($response->Result as $invoices)
    echo $invoices->Id."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server お問い合わせ

この記事の内容

関連記事