ノーコードでクラウド上のデータとの連携を実現。
詳細はこちら →
CData Virtuality - REST APIでの接続
はじめに
CData Virtualityは、エンタープライズグレードのデータ仮想化プラットフォームです。データ仮想化によるリアルタイムデータアクセスとデータレプリケーションのバイモーダルによるデータ連携を提供します。本記事では、CData Virtuality Serverの仮想データベースに対してREST APIでデータアクセスする方法をご紹介します。
事前準備
CData Virtualityには、インストール版とフルマネージドクラウド(SaaS)版がございます。入手および初期設定方法は以下の記事をご参照ください。
CData Virtuality のREST APIについて
CData Virtualityでは、REST APIのインタフェースを提供しています。これにより、外部のAPIクライアントからCData Virtuality Server内の仮想データベース内のデータにアクセスすることが出来ます。
Data Virtuality Serverが公開するREST APIの仕様についてはこちらの製品ドキュメントからもご参照いただけます。
APIクライアントツール Postmanの入手
本手順では、PostmanというAPIクライアントツールからCData Virtuality Serverに接続します。こちらのページよりPostmanのDesktopアプリケーションを入手してください。
API エンドポイントの確認
インストール版のAPIエンドポイントは以下の通りです。
GET http://<datavirtuality-server-address>:8080/rest/api/status/
上記に加えて、Basic認証のためのCData Virtuality Serverのユーザ、および、パスワードが必要となります。
SaaS版のAPIエンドポイントは、CData Virtuality Web Interface画面のPreferenceから取得することができます。
APIs配下のRESTがEnable（有効）になっていることを確認して「Copy link」ボタンをクリックします。
http://<datavirtuality-server-address>/<token>/rest
こちらの文字列は後の手順で利用するので手元に控えておきます。
なお、REST APIエンドポイントにアクセスする際の認証情報としてDatabase Credentials配下のDatabase Username:も必要となるため控えておきます。
疎通確認
Postmanを利用して、まずはじめに、REST APIを通じてCData Virtuality Serverのステータス確認を行ってみます。
インストール版
GET http://<datavirtuality-server-address>:8080/rest/api/status/ Authentication : Basic Auth (CData Virtuality Serverのユーザ、および、パスワード)
SaaS版
GET http://<datavirtuality-server-address>/<token>/rest/api/status/ Authentication : Basic Auth (Database Username、および、パスワード)
Statusが200でレスポンスのBodyに「"status": "OK"」が返ってきていれば成功です。
スキーマ一覧の取得
CData Virtuality Serverのスキーマの一覧にアクセスしてみます。
インストール版
GET http://<datavirtuality-server-address>:8080/rest/api/source Authentication : Basic Auth (CData Virtuality Serverのユーザ、および、パスワード)
SaaS版
GET http://<datavirtuality-server-address>/<token>/rest/api/source/ Authentication : Basic Auth (Database Username、および、パスワード)
スキーマ内のオブジェクト一覧の取得
スキーマ内のオブジェクト（テーブルやビュー）の一覧にアクセスしてみます。
インストール版
GET http://<datavirtuality-server-address>:8080/rest/api/source Authentication : Basic Auth (CData Virtuality Serverのユーザ、および、パスワード)
SaaS版
GET http://<datavirtuality-server-address>/<token>/rest/api/source/ Authentication : Basic Auth (Database Username、および、パスワード)
オブジェクト内のデータへのアクセス
オブジェクト（テーブルやビュー）内のデータへアクセスしてみます。下記の例ではサンプルMySQL内のCustomersテーブルのデータにアクセスする例です。
インストール版
GET http://<datavirtuality-server-address>:8080/rest/api/source/mysql/Customers Authentication : Basic Auth (CData Virtuality Serverのユーザ、および、パスワード)
SaaS版
GET http://<datavirtuality-server-address>/<token>/rest/api/source/mysql/Customers Authentication : Basic Auth (Database Username、および、パスワード)
まとめ
本記事では、CData Virtuality Serverの仮想データベースに対してREST APIでデータアクセスする方法をご紹介しました。CData Virtualityはフルマネージドクラウド(SaaS)版、および、インストール版で無償トライアルを提供しています。無償トライアルを始められたい方や設定を進める中でご不明な点が出てきた際には弊社テクニカルサポートまでお問い合わせください。