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

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

CData ODBC ドライバとは？

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

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

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

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

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

通常はCData ODBC ドライバのインストール後にODBC DSN 接続ウィザードが立ち上がり、設定を行うことができます。 もしODBC DSN 接続が未済の場合には、Microsoft ODBC データソースアドミニストレータでODBC DSN を作成および設定することができます。

Zendesk 接続プロパティの取得・設定方法

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

1. Token アクセスを有効にします。
2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。

その他の認証方法についてはヘルプドキュメントを参照してください。

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

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

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

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

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

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

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, Subject FROM Tickets")

#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 からZendesk のデータへ接続できるようになります。簡単にコマンドラインからファイルを叩いて接続を確認してみましょう。

ruby ZendeskSelect.rb

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

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

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