CData Virtuality はREST API インターフェースを提供し、外部のAPI クライアントがCData Virtuality Server でホストされている仮想データベースのデータにアクセスできるようにします。これがそのプロセスです:
このガイドでは、API クライアントツールPostman を例として使用します。ただし、他のAPI クライアントツールを使用することもできます。
For detailed specifications of the REST API used by the CData Virtuality Server, see REST API.
Postman
API クライアントツールPostman はhere から無料でダウンロードできます。
Configuration for Windows
Checking API Endpoints
API エンドポイントは以下のとおりです:
GET http://<datavirtuality-server-address>:8080/rest/api/status/
上記に加えて、基本認証にはCData Virtuality Server のユーザー名とパスワードが必要です。
Communication Confirmation
Postman を使って、まずREST API でCData Virtuality Server のステータスを以下のリクエスト詳細で確認します:GET http://<datavirtuality-server-address>:8080/rest/api/status/
認証:CData Virtuality Server のユーザー名とパスワードを使用したBasic 認証
応答ステータスが200で、本文に"status": "OK"
が含まれていれば、CData Virtuality Server との通信は成功です。
Obtaining the List of Schemas
CData Virtuality Server からスキーマのリストを取得するには、以下の手順に従います:
GET http://<datavirtuality-server-address>:8080/rest/api/source
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
Obtaining the List of Objects in a Schema
CData Virtuality Server 上のスキーマ内のオブジェクト(テーブルとビュ ー)のリストを取得するには、以下の手順に従います:
GET http://<datavirtuality-server-address>:8080/rest/api/source
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
Accessing Data in Objects (Table or View)
以下の例では、MySQL サンプルデータベースの Customers テーブルのデータにアクセスしています。
GET http://<datavirtuality-server-address>:8080/rest/api/source/mysql/Customers
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
Configuration for SaaS
Checking API Endpoints
SaaS バージョンのAPI エンドポイントは、CData Virtuality Web UI のPreferencesセクションから取得できます:
APIs のREST が有効になっていることを確認して、Copy link ボタンをクリックします。
この文字列は後のステップで使用するので、手元に控えておいてください。
なお、データベースユーザー名(データベース認証情報の下にあります)も、REST API エンドポイントにアクセスする際の認証に必要です。
Communication Confirmation
Postman を使用して、まず次のリクエスト詳細を使ってREST API 経由でCData Virtuality Server のステータスを確認します:
GET http://<datavirtuality-server-address>/<token>/rest/api/status/
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
応答ステータスが200で、本文に"status": "OK"
が含まれていれば、CData Virtuality Server との通信は成功です。
Obtaining the List of Schemas
CData Virtuality Server からスキーマのリストを取得するには、以下の手順に従います:
GET http://<datavirtuality-server-address>/<token>/rest/api/source/
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
Obtaining the List of Objects in a Schema
CData Virtuality Server 上のスキーマ内のオブジェクト(テーブルとビュ ー)のリストを取得するには、以下の手順に従います:
GET http://<datavirtuality-server-address>/<token>/rest/api/source/
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
Accessing Data in Objects (Table or View)
以下の例では、MySQL サンプルデータベースの Customers テーブルのデータにアクセスしています。
GET http://<datavirtuality-server-address>/<token>/rest/api/source/mysql/Customers
認証:CData Virtuality Server の認証情報を使用したBasic 認証。
See Also
REST API CData Virtuality でのREST API の使用に関する詳細はこちらをご覧ください。