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

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



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

API Server の設定

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

Kintone への接続

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

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

  5. Kintone 接続プロパティの設定方法

    それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

    • URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
    • User：アカウントのユーザー名
    • Password：アカウントのパスワード
    • AuthScheme：「Password」を指定

    パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

    Basic 認証の設定

    続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

    • BasicAuthUser：Basic 認証のユーザー名
    • BasicAuthPassword：Basic 認証のパスワード

    クライアント証明書認証の設定

    Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

    • SSLClientCert：クライアント証明書のパス
    • SSLClientCertType：証明書の種類
    • SSLClientCertSubject：証明書のサブジェクト
    • SSLClientCertPassword：証明書のパスワード
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Kintone 接続プロパティの設定方法

それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

  • URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
  • User：アカウントのユーザー名
  • Password：アカウントのパスワード
  • AuthScheme：「Password」を指定

パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

Basic 認証の設定

続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

  • BasicAuthUser：Basic 認証のユーザー名
  • BasicAuthPassword：Basic 認証のパスワード

クライアント証明書認証の設定

Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

  • SSLClientCert：クライアント証明書のパス
  • SSLClientCertType：証明書の種類
  • SSLClientCertSubject：証明書のサブジェクト
  • SSLClientCertPassword：証明書のパスワード

API Server のユーザー設定

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

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

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

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

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

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

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

Kintone 接続プロパティの設定方法

それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

  • URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
  • User：アカウントのユーザー名
  • Password：アカウントのパスワード
  • AuthScheme：「Password」を指定

パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

Basic 認証の設定

続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

  • BasicAuthUser：Basic 認証のユーザー名
  • BasicAuthPassword：Basic 認証のパスワード

クライアント証明書認証の設定

Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

  • SSLClientCert：クライアント証明書のパス
  • SSLClientCertType：証明書の種類
  • SSLClientCertSubject：証明書のサブジェクト
  • SSLClientCertPassword：証明書のパスワード

さらに、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\Kintone\
  • Unix or Mac OS X：~/cdata/Kintone/

Kintone エンティティを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\KintoneEntities.php

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

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

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

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

    require_once 'KintoneEntities.php';
try{
  $svc = new CData();
  $apps = new Apps();
  $apps->AppId = '1354841';
  $svc->AddToApps($apps);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->apps()->Execute();
  foreach($response->Result as $apps)
    echo $apps->Name."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server お問い合わせ

この記事の内容

関連記事