Overview

REST API は、GET、PUT、POST、DELETEデータへの HTTP リクエストを使用します。CData Virtuality REST API を使用してCData Virtuality 上に Web サービスを構築し、他のアプリケーションとの統合を開発できます。

このガイドでは、CData Virtuality で使用可能な REST エンドポイントと、予想される HTTP レスポンスコードを例とともに説明します。

現在のところ、2つのLIMITがありますのでご注意ください。まず、CData Virtuality REST API は JSON コンテントタイプのみをサポートしています。HTTP クライアント（Postmanなど）を使用する場合は、言語検出をJSON に設定することをお勧めします。第2に、CData Virtuality REST API はデフォルトの仮想データベース (datavirtuality) でのみ動作します。このため、どのコマンドでもVDB 名やID の指定は必要ありません。

Authentication (On-premise)

基本HTTP認証は最も簡単な認証方法ですが、安全ではありません。その代わりに、特別なアプリを使ったより安全なアプリケーション認証をお勧めします。Postmanを使用している場合は、Authorizationタブを開き、Basic Authを選択し、認証情報を入力します。認証情報が正しいかどうかを確認するには、status エンドポイントに以下の呼び出しを実行します：

その後、サーバーは REST API ステータスを応答します：

Authentication (SaaS)

CData Virtuality のSaaS バージョンはトークンベースの認証を使用します。そのためには、PreferencesWeb UIのセクションから取得できるトークンを含むデータベースユーザー名とREST API リンクが必要です。以下の手順に従ってください：

1. Preferencesで、Proxy configurations and Database Usernameセクションを見つけ、RESTの横にあるスイッチを切り替えて有効にします（まだ有効になっていない場合）：

2. Copy ]ボタンをクリックして、トークンと一緒にリンクをコピーします：

次のようなリンクが届きます：https://<cdatavirtuality-address>/XXXXXXXX/rest このXXXXXXXXがあなたのトークンです。

Postmanを使用している場合は、AUTHORIZATIONタブに移動し、Basic Authを認証タイプとして選択し、Proxy configurations and Database Usernameセクション（上記のスクリーンショットを参照）にあるデータベースユーザー名と、Platformアカウントのパスワードを入力します。以下のリクエストを送信することで、すべてが正しいかどうかを確認できます：

すべてが正常であれば、ステータス200 OK が返されます：