Ruby でCarbone のデータ連携アプリを構築
CData ODBC Driver for API を使うと、簡単にRuby アプリケーションにリアルタイムCarbone のデータを連携・統合できます。 この記事では、Carbone のデータにリアルタイムに連携するRuby アプリケーションを構築して、クエリを実行し、結果を表示してみます。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- Carbone をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにCarbone のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてCarbone の接続を設定、2.Ruby 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとCarbone への接続設定
まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
通常はCData ODBC ドライバのインストール後にODBC DSN 接続ウィザードが立ち上がり、設定を行うことができます。 もしODBC DSN 接続が未済の場合には、Microsoft ODBC データソースアドミニストレータでODBC DSN を作成および設定することができます。
まず、Profile 接続プロパティをディスク上の Carbone プロファイルの場所に設定します(例:C:\profiles\Carbone.apip)。次に、ProfileSettings 接続プロパティを Carbone の接続文字列に設定します(以下を参照)。
Carbone API プロファイル設定
Carbone では、Authorization ヘッダーの Bearer トークンによる API キー認証を使用します。API キーは以下の手順で取得できます。
- https://account.carbone.io で Carbone アカウントにログインします。
- アカウントのホームページに表示されている API キーをコピーします。
API キーを取得したら、以下の接続プロパティを設定します。
- AuthScheme:APIKey に設定します。
- APIKey:Carbone の API キー(Bearer トークン)に設定します。
- CarboneVersion:(オプション)carbone-version リクエストヘッダーで指定する、対象の Carbone API のメジャーバージョンです。デフォルトは 5 です。指定できる値は 5、4、3、staging です。
Ruby および必要なGem のインストール
Ruby をまだインストールしていない場合は、Ruby インストールページを参考にインストールしてください。 Ruby をインストールしたら、次にruby-dbi、dbd-odbc、ruby-odbc gems をインストールします。
gem install dbi
gem install dbd-odbc
gem install ruby-odbc
Carbone のデータに連携する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, Name FROM Templates WHERE Category = 'Invoices'")
#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 からCarbone のデータへ接続できるようになります。簡単にコマンドラインからファイルを叩いて接続を確認してみましょう。
ruby APISelect.rb
Carbone からRuby へのデータ連携には、ぜひCData ODBC ドライバをご利用ください
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。