Kairos3 に Excel や PowerBI 、ETLツールなど色々なツールから接続

by 宮本航太 | 2022年06月29日

こんにちは、シニアプロダクトスペシャリストの宮本です。

本記事では、各種 Web API を ODBC / JDBC / ADO.NET といった標準のDB接続規格でアクセスできるようにするCData API Driverを用いて、Kairos3 の API を各種ツールから接続する方法を紹介します。

ExcelやAccess・Power BIなどのエンドユーザーが利用するUIベースのツールはもちろん、Visual StduioやEclipseといった開発ツールからも接続することが可能です。


Kairos3 とは?

Kairos3とは規模の大小問わずさまざまな企業での利用に適したマーケティングオートメーションツールです。

https://www.kairosmarketing.net/marketing-automation

業種や売上規模などの顧客情報に加え、Webサイト閲覧、メール開封、イベント参加、購買履歴などの顧客との接点を記録するカルテを作成することができるため、営業活動においてスムーズに顧客情報を活用することができます。

またオプションとして「特定条件のメール自動配信」、「Kairos3 API」、「ファイル管理・共有」という機能をつけることが可能です。

例えば Kairos3 と Salesforce の連携機能があり、これらは内部ではAPI連携をしていますが簡単な画面設定のみで利用できるような機能も提供しているようです。

今回はその中の「Kairos3 API」を利用した Cdata API Driver の利用方法を行っていきます。

実現イメージ

この記事では Kairos3 に対してBIやETL/EAIなど、様々なツールから接続します。しかしながら、各APIは単純にツールと接続・連携することはできません。

各ツールがどのようにWeb API側へリクエストを投げるべきかの判断材料や各種認証方法の処理、メタデータの情報等が無いためです。そのためには基本的にカスタムコネクタを作るか、プログラムを組まなければいけません。

そこで、CData API Driver を用いて、このボトルネックを解決します。

まず、各ツールからはODBCやJDBCインタフェースでSQL(Select文)をCData API Driverに向けて発行してもらいます。そのリクエストを受け取った CData API Driverは、Kairos3 の API のエンドポイントに対して、SQL文を解釈し、HTTPリクエスト発行します。

リクエスト後、JSONフォーマットで返ってきたデータをCData API Driverが各種インタフェースフォーマットにデータを変換してツールに返します。

これにより、各種ツールからアドホックにSQLによるリクエストがあったタイミングで最新のデータを Kairos3 から取得することが可能となります。


各種接続シナリオと必要なツール

CData API Driver は様々なツールとの接続に利用できますが、今回は以下のツールを用いて接続する方法を解説していきます。

  • Excel(Excel-addin で利用)
  • Access(ODBC 接続で利用)
  • PowerBI (Power BI Connector 接続で利用)
  • ASTERIA Warp(JDBC Driver 接続で利用)
  • CDataSync

なお、CData API Driverは上記以外にも様々なツールと連携することが可能です。

Kairos3 のビュー一覧

Kairos3 のAPIは外部公開されており、CData API Driver ではそれらのエンドポイントを読み取り専用のビューとして定義しています。

https://kairos3.com/help/api.html


対応表は下記のとおりです。

Name

Resource

API Reference

Customers

リード情報取得

リンク

Customers
※下記条件指定でHOTリード情報取得
select * from Customers where Hot = 'True'

HOTリード情報取得

リンク

Companies

会社情報取得

リンク

Projects
ProjectStageLogs
ProjectTodos
ProjectSalesLogs
ProjectCustomers
ProjectCompanys
※配列で返ってくる部分を各ビューとして定義

SFA案件一覧取得

リンク

Candidates

SFA案件候補取得

リンク

Kairos3 のAPI利用準備

Kairos3 ではAPIKeyを使って Kairos3 API に接続していくので、まずは「APIKey」を発行してもらう必要がありますが、そのためには 「Kairos3 API」の契約が別途必要となります。

https://www.kairosmarketing.net/marketing-automation/pricing

とは言え、テストアカウントは誰でも利用できるよう外部公開されていますので、すぐに Kairos3 API を試してみることが可能です。

https://kairos3.com/help/api.html#%E3%83%86%E3%82%B9%E3%83%88%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88


Kairos3 用API Profile の取得

CData API Driver を利用して接続するために、Kairos3 用のAPI Profile が必要です。

先ほど紹介したビューの定義が含まれたAPI Profile が こちら からダウンロードできます。

ダウンロードしたAPI Profile(Kairos3.apip)は、ツールからアクセスが可能な任意のフォルダに配置してください。この記事では C:\APIProfiles\Kairos3.apip に配置しています。

CData API Driver インストール

それでは各種ツールとKairos3 を繋ぐために必要となる CData API Driver をインストールします。

基本的なインストール・設定方法は各種Driver共通ですので、ここではODBC Driverを例に説明します。

まず、CData API ODBC Driverの30日間の評価版をダウンロードします。ダウンロードの際には、Emailの登録が必要となります。

https://www.cdata.com/jp/apidriver/download/

ダウンロードしたsetup.exeファイルをBIツールがインストールされているマシンにインストールします。インストールウィザードに従い、EULAを確認した上でインストールを完了します。

※途中、ライセンスサーバーへのオンラインアクティベーションが行われるためネットワーク環境に接続されている必要があります。

インストールが完了すると、ODBCのDSN設定のウィンドウが立ち上がります。

以下の項目をセットし、「接続のテスト」をクリックします。

プロパティ名

備考

Profile

C:\Publish\lib\v21\APIProfiles\Kairos3.apip

ダウンロードしたKairos3.apipのパスを指定

ProfileSettings

APIKey=xxxxxxx

Kairos3から取得したAPIKeyを指定





「接続テストに成功しました。」とポップアップが表示されたらOKボタンを押して保存します。

それでは実際に各種ツールからの接続方法を解説していきましょう。


Excel から Kairos3 に接続(Excel Add-in for API)

CData Excel Add-in for API をインストール後、Excelを立ち上げるとCDataタブが追加されていることがわかります。このタブから各種操作を実施します。

接続を開始するには、CDataタブから[取得元 API]をクリックします。

最初に接続するためのウィザードが表示されるので、「CData API Driverのインストール」の内容と同様に各種パラメータを入力します。

接続後、対象テーブルを選択し、クエリを編集の上、「OK」をクリックします。

クリック後、対象のデータが一括で取得できます。


Access リンクテーブル から Kairos3 に接続(CData API ODBC Driver)

次はCData ODBC Driverを利用して、Access リンクテーブルから接続してみたいと思います。

あらかじめ新規にAccessを立ち上げて、空のデータベースを作成しておきましょう。

続いて「外部データ」タブから「新しいデータ ソース」→「他のソースから」→「ODBC データベース」を選択します。

ウィザードが表示されるので「リンクテーブルを作成」を選択し、「OK」をクリックします。

データソースの選択では「コンピューターデータソース」から事前に作成したCData API Driver用DSNを選択し「OK」をクリック

テーブルの一覧が表示されるので、任意のテーブルを選択し「OK」をクリックします。

設定後、リンクテーブルが追加され、以下のように Kairos3 のデータを閲覧することができるようになります。もちろん、通常通りクエリデザイナーでも使用可能です。

PowerBI から Kairos3 に接続(CData API Driver for Power BI)

次は CData Power BI API Connector を用いて、Power BIから Kairos3 の顧客情報を取得します。

PowerBI Desktopを起動して、「データを取得」をクリックします。

データ接続先一覧の中から「CData API」を選択し、「接続」をクリックします。

データソース名は先程登録した Kairos3 のDSNを入力し「OK」をクリックします。


あとはPoewr BIの機能を用いて、ビジュアライズに利用することができます。


ASTERIA Warp から Kairos3 に接続(CData JDBC API Driver)

ASTERIA Warpでは、フローデザイナーを使って、データ処理のプロセスを作成します。

フローデザイナーの基本的な利用方法についてはWarpのフローデザイナー操作ガイドをご覧ください。

CData JDBC API Driver はインストール後、「cdata.jdbc.api.jar」と「cdata.jdbc.api.lic」のファイルをAsteriaのドライバーフォルダ(asteriahome5\system\lib\drivers)に登録します。

その後、ASTERIA Warpを立ち上げて、フローデザイナーにアクセスし、CData JDBC Driverを使用するために接続を追加します。

画面左のコネクションペイン上にある電源ボタンをクリックをクリックすると、「コネクションの作成」ダイアログが表示されます。



「接続種別」として「RDB」を選択、「名前」に分かりやすい名前を設定し「OK」をクリックします。

作成したコネクションをダブルクリックすると、画面右のインスペクタに接続プロパティが表示されます。 「基本」タブでドライバーのパスとURLをそれぞれ設定します。

プロパティ名

備考

ドライバーのパス

例)C:\asteriahome5\system\lib\drivers\cdata.jdbc.api.jar

URL

jdbc:api:Profile=C:\Publish\lib\v21\APIProfiles\Kairos3.apip;

ProfileSettings='APIKey=xxxxxxxxxx;';


構成後、「接続のテスト」を実行して、成功すればOKです。

これでコネクションの作成は完了です。あとは、フロー上でデータベースタブにある「RDBGet」のコンポーネントを使って、データの取得が行なえます。

「RDBGet」フローに配置し、ダブルクリックします。

コネクションの選択ウインドウが表示されるので、先程作成した Kairos3 のコネクションを選択しましょう。

その後、SQLビルダーが表示されるので、取得したいデータが格納されている、任意のテーブルとカラムを選択します。

あとは、「モデルにSQLを適用する」をクリックし「SELECTテスト」でデータが正常に取得できているかを確認します。

以下のようにデータが参照できれいればOKです。設定を保存してSQLビルダーを閉じます。

これで Asteria Warp の機能で様々なサービスと Kairos3 のデータの連携を実現できます。


CData Sync から Kairos3 に接続

https://www.cdata.com/jp/sync/

CData Sync ではデータソースとして、Kairos3 に接続することができます。

なお、CData Sync Windows版の場合は「Kairos3.apip」のプロファイルをSyncの本体が存在するフォルダの「www\app_data\profiles」に配置してください。profilesフォルダが存在しない場合は手動で作成してください。

> C:\ProgramData\CData\sync\profiles

Cross-Platform版の組み込みJettyで構成している場合は、以下のフォルダにapipファイルを配置します。

> /opt/sync/profiles


配置後、CDataSyncを起動すると以下のようにデータソースとして Kairos3 が利用できるようになります。

接続プロパティは以下の通り設定します。

プロパティ名

備考

ProfileSettings

APIKey=xxxxxxx

Kairos3から取得したAPIKeyを指定

併せて、任意の同期先の接続情報も構成しておきましょう。

接続完了後、新しくジョブを作成します。

先程作成した Kairos3 のコネクションを選択します。

ジョブを作成した後は、Kairos3 の同期対象となる任意のテーブルを選択しましょう。

データのプレビュー画面で、実際に取得が成功しているかどうかを確認できました。

あとは、任意のスケジュールを指定してデータのレプリケーションを実行できます。

試しに手動で実行してみると、それぞれのレプリケーション件数が結果として表示されます。

RDBの中でもレプリケーションされたデータが確認できました。



おわりに

これら以外にもCData API Driverは各種ETLツールや帳票ツールなどからも接続することが可能です。

以下のCData オンラインナレッジベースには、各種ツールからの接続方法を紹介した記事が多数掲載されているので、是非見てみてください。

https://www.cdata.com/jp/kb/

不明な点があれば、テクニカルサポートまでお気軽にどうぞ!

https://www.cdata.com/jp/support/submit.aspx

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。