Ruby でHarvest のデータ連携アプリを構築

古川えりか
古川えりか
コンテンツスペシャリスト
Ruby でODBC 経由でHarvest に接続して、モダンなクラウド連携アプリを開発。

CData ODBC Driver for API を使うと、簡単にRuby アプリケーションにリアルタイムHarvest のデータを連携・統合できます。 この記事では、Harvest のデータにリアルタイムに連携するRuby アプリケーションを構築して、クエリを実行し、結果を表示してみます。

CData ODBC ドライバとは？

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

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

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

CData ODBC ドライバのインストールとHarvest への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

通常はCData ODBC ドライバのインストール後にODBC DSN 接続ウィザードが立ち上がり、設定を行うことができます。 もしODBC DSN 接続が未済の場合には、Microsoft ODBC データソースアドミニストレータでODBC 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 を取得および更新する方法を管理できます。

Ruby および必要なGem のインストール

Ruby をまだインストールしていない場合は、Ruby インストールページを参考にインストールしてください。 Ruby をインストールしたら、次にruby-dbi、dbd-odbc、ruby-odbc gems をインストールします。 

gem install dbi
gem install dbd-odbc
gem install ruby-odbc

Harvest のデータに連携するRuby アプリケーションの作成

Ruby ファイル (例: APISelect.rb) を作成し、テキストエディタで開きます。ファイルに次のコードをコピーします: 

#connect to the DSN
require 'DBI'
cnxn = DBI.connect('DBI:ODBC:CData API Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, ClientName FROM Invoices WHERE State = 'open'")

#display the names of the columns
resultSet.column_names.each do |name|
  print name, "\t"
end
puts

#display the results
while row = resultSet.fetch do
  (0..resultSet.column_names.size - 1).each do |n|
    print row[n], "\t"
  end
  puts
end
resultSet.finish

#close the connection
cnxn.disconnect if cnxn

これで、Ruby からHarvest のデータへ接続できるようになります。簡単にコマンドラインからファイルを叩いて接続を確認してみましょう。 

ruby APISelect.rb

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

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

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

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

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

Harvest に接続 お問い合わせ

この記事の内容

関連記事