Linux/Unix 上でPHP からHarvest のデータに接続・連携

古川えりか
古川えりか
コンテンツスペシャリスト
CData ODBC ドライバを使って、Linux/Unix マシン上でHarvest のデータに連携可能なPHP アプリケーションを作成。PHP でのODBC ネイティブサポートを活用します。

CData ODBC Driver for API をLAMP またはWAMP スタックにドロップし、Harvest に接続されたWeb アプリケーションを構築します。本記事では、PHP のビルトインODBC 機能でHarvest のデータに接続し、クエリを実行して、結果を出力する手順を説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

  1. Harvest をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
  2. 多様なアプリケーション、ツールにHarvest のデータを連携
  3. ノーコードでの手軽な接続設定
  4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてHarvest の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

UNIX/Linux マシンでCData ODBC Drivers を使用する

CData ODBC Drivers は、Ubuntu、Debian、RHEL、CentOS、Fedora など、Red Hat およびDebian ベースのさまざまなシステムでサポートされています。また、いくつかライブラリやパッケージが要求されることがありますが、それらの多くはシステムにデフォルトでインストールされています。サポートされているLinux オペレーティングシステムのバージョンと必要なライブラリの詳細については、インストール済みのもの、またはWeb 上にあるヘルプドキュメントの「はじめに」の章を参照してください。

ドライバーマネージャーをインストールする

ドライバーをインストールする前に、システムにドライバーマネージャーがあることを確認してください。この記事では、広くサポートされている無料のオープンソースODBC ドライバーマネージャーであるunixODBC を使用します。

Ubuntu のようなDebian ベースのシステムでは、APT パッケージマネージャーを使用してunixODBC をインストールできます。

$ sudo apt-get install unixODBC unixODBC-dev

Red Hat Linux ベースのシステムの場合は、yum またはdnf を使用してunixODBC をインストールできます。

$ sudo yum install unixODBC unixODBC-devel

unixODBC ドライバーマネージャーは、ドライバーの情報をodbcinst.ini ファイルから、データソースの情報をodbc.ini ファイルから読み取ります。 次のコマンドをターミナルに入力することで、システムの設定ファイルの場所を指定できます。

$ odbcinst -j

コマンドの出力は、登録されたODBC ドライバーおよびODBC データソースの設定ファイルの場所を表示します。 ユーザーデータソースにアクセスできるのは、odbc.ini ファイルがホームフォルダに格納されているユーザーアカウントだけです。システムデータソースには、すべてのユーザーがアクセスできます。 以下に、このコマンドの出力例を示します。

DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......:8
SQLLEN Size........:8
SQLSETPOSIROW Size.:8

ドライバーをインストールする

標準パッケージ形式（Debian .deb パッケージ形式または.rpm ファイル形式）でドライバーをダウンロードすることができます。ファイルをダウンロードしたら、ターミナルからドライバーをインストールできます。

ドライバーインストーラーはドライバーをunixODBC に登録し、システムDSN を作成します。これは、後にODBC 接続をサポートするツールやアプリケーションで使用できます。

Ubuntu のようなDebian ベースのシステムでは、sudo またはroot で以下のコマンドを実行します。 

$ dpkg -i /path/to/package.deb

Red Hat システムまたは.rpms をサポートするその他のシステムの場合は、sudo またはroot で以下のコマンドを実行します。 

$ rpm -i /path/to/package.rpm

ドライバーがインストールされたら、unixODBC ドライバーマネージャーを使用し、登録されたドライバーと定義されたデータソースを一覧表示できます。

登録されているドライバーを一覧表示する

$ odbcinst -q -d
CData ODBC Driver for API
...

定義されたデータソースを一覧表示する

$ odbcinst -q -s
CData API Source
...

CData ODBC Driver for API をunixODBC で使用するには、ドライバーがUTF-16 を使用するように設定されていることを確認します。そのために、インストール場所（通常はcdata.odbc.api.ini）のlib フォルダにある、ドライバー（cdata.odbc.api.ini）のINI ファイルを以下のように編集します。

cdata.odbc.api.ini

...

[Driver]
DriverManagerEncoding = UTF-16

DSN を変更する

ドライバーのインストールにより、システムDSN が事前定義されます。DSN を変更するには、システムデータソースファイル（/etc/odbc.ini）を編集し、必要な接続プロパティを定義します。さらに、$HOME/.odbc.ini での変更にルートアクセスを必要としない、ユーザー固有のDSN を作成することができます。

まず、Profile 接続プロパティをディスク上のHarvest プロファイルの場所に設定します（例：C:\profiles\Harvest.apip）。次に、ProfileSettings 接続プロパティをHarvest の接続文字列に設定します（以下を参照）。

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • ProfileSettings：ProfileSettings でAccountId を設定します。
  • AuthScheme：OAuth に設定します。
  • OAuthClientId：アプリ設定で指定したclient ID に設定します。
  • OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
  • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

/etc/odbc.ini または$HOME/.odbc.ini

[CData API Source]
Driver = CData ODBC Driver for API
Description = My Description
Profile = C:\profiles\Harvest.apip
ProfileSettings = 'APIKey = my_personal_key
AccountId = _your_account_id'

これらの構成ファイルの使用方法については、オンラインのヘルプドキュメントを参照してください。

接続を確立する

odbc_connect またはodbc_pconnect を呼び出して、Harvest への接続を開きます。 接続を閉じるには、odbc_close もしくはodbc_close_all を使います。

$conn = odbc_connect("CData ODBC API Source","user","password");

接続はodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いた接続は、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトで接続を共有することが可能です。スクリプト間で接続を共有することにより、システムリソースを節約し、クエリの実行を高速化できます。

$conn = odbc_pconnect("CData ODBC API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

プリペアドステートメントを作成する

odbc_prepare を使って、プリペアドステートメントおよびパラメータライズドクエリを作成します。 

$query = odbc_prepare($conn, "SELECT * FROM Invoices WHERE State = ?");

クエリを実行する

Prepared ステートメントをodbc_execute を使って実行します。 

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Invoices WHERE State = ?");
$success = odbc_execute($query, array('open'));

Non-Parameterized クエリは、odbc_exec を使います。 

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT Id, ClientName FROM Invoices WHERE State = 'open'");

結果の処理

odbc_fetch_array 関数の結果セット配列としてアクセスします。

$conn = odbc_connect("CData ODBCHarvest のデータSource","user","password");
$query = odbc_exec($conn, "SELECT Id, ClientName FROM Invoices WHERE State = 'open'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

odbc_result_all 関数で、結果セットをHTML テーブルとして表示します。

$conn = odbc_connect("CData ODBCHarvest のデータSource","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Invoices WHERE State = ?");
$success = odbc_execute($query, array('open'));
if($success)
  odbc_result_all($query);

他のサンプルクエリ

ドライバーがサポートしているSQL の詳細は、ヘルプドキュメントを参照してください。上のサンプルは、PHP community documentation for all ODBC functions をHarvest 向けに変更したものです。

Harvest からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

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

API Driver で Harvest のライブデータに接続

Harvest に接続 お問い合わせ

この記事の内容

関連記事