PHP からAha のデータに接続する方法
CData ODBC Driver for API は、PHP アプリケーションからAha のデータへの連携を実現します。本記事では、Aha のデータをPHP のビルトインODBC 機能でクエリする手順を説明します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- Aha をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにAha のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてAha の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとAha への接続設定
まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
Aha に接続するDSN を作成します。
- まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。ODBC データソースアドミニストレータを使用してDSN を作成および設定する方法については、ヘルプドキュメントの「はじめに」の章を参照してください。
まず、Profile 接続プロパティをディスク上のAha! プロファイルの場所に設定します(例:C:\profiles\aha.apip)。次に、ProfileSettings 接続プロパティをAha! の接続文字列に設定します(以下を参照)。
Aha! API プロファイル設定
Aha! API はOAuth ベースの認証を使用します。
まず、Aha! でOAuth アプリを登録する必要があります。これはAha! アカウントの「Settings」>「Personal」>「Developer」>「OAuth Applications」から行えます。また、Aha アカウントのドメイン名にあるDomain を設定します。例えば、Aha アカウントがacmeinc.aha.io の場合、Domain は「acmeinc」となります。
以下の項目を接続文字列に設定すると、接続できるようになります。
- AuthScheme:OAuth に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
- OAuthClientId:アプリ設定で指定されたclient_id に設定します。
- OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
- CallbackURL:アプリ設定で指定したRedirect URI に設定します。
- Domain:ProfileSettings でAha ドメインに設定します。
Aha への接続の確立
odbc_connect を呼び出して、Aha への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。
$conn = odbc_connect("CData API Source","user","password");
コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:
$conn = odbc_pconnect("CData API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly
エレメントの作成
odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。
$query = odbc_prepare($conn, "SELECT * FROM Ideas WHERE AssignedToUserId = ?");
クエリの実行
Prepared ステートメントをodbc_execute を使って実行します。
$conn = odbc_connect("CData API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Ideas WHERE AssignedToUserId = ?");
$success = odbc_execute($query, array('my_user_id'));
Non-Parameterized クエリは、odbc_exec を使います。
$conn = odbc_connect("CData API Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Ideas");
結果の処理
odbc_fetch_array ファンクションの結果セット配列としてアクセスします。
$conn = odbc_connect("CData API Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Ideas");
while($row = odbc_fetch_array($query)){
echo $row["Id"] . "\n";
}
odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。
$conn = odbc_connect("CData API Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Ideas WHERE AssignedToUserId = ?");
$success = odbc_execute($query, array('my_user_id'));
if($success)
odbc_result_all($query);
サンプルクエリのテスト
スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。
PHP の最新版のバイナリのダウンロード。
フォルダにファイルを入れる。
フォルダを開く。
php.ini-development をphp.ini に変更。
ブラウザからテストスクリプトにアクセスするためのコマンドを実行。
php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini
他のサンプルクエリ
サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、Aha 向けに最適化したものです。
Aha からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。