REST APIへの接続

最終更新: 2025年3月17日

REST APIへの接続

REST API コネクタに接続するには、 Data Virtualization で特定の情報が必要です。

詳細については、オブジェクトストレージ内のデータソース Data Virtualization をご覧ください。

始める前に

REST API との接続を設定するには、以下の接続詳細情報が必要です

ホスト名 URL

手順

Data Virtualization の REST API と接続するには、以下の手順に従ってください。

ナビゲーションメニューで、「データ」> Data virtualizationデータソースページが表示されます。
データソースの一覧を表示するには、 [接続の追加] > [新しい接続] をクリックします。
REST API データソース接続を選択します。
接続名と説明を入力します。
ホストデータベースの URL を入力してください。 REST API データソースへの接続を設定するには、サンプルプロパティメソッドとモデルファイルメソッドの2つの方法から選択できます。

プロパティメソッドのサンプル

サンプルプロパティメソッドを使用している場合は、ホスト名のエンドポイントを次のように指定します。 URL : https://domain.example.com/api/v1/employee_name。サンプルプロパティメソッドを使用すると、最小限の設定で単一のエンドポイントからデータにアクセスできます。 Modelファイルを提供する必要はありません。
モデルファイル方式
- Modelファイル方式を使用している場合は、ホスト名のベース URL （https://domain.example.com ）を入力して、複数のエンドポイントからのデータへのアクセスを許可します。
- この方法では、手動でモデルファイルを作成し、そのファイルをモデルファイルフィールドに貼り付ける必要があります。モデルファイルを作成し、エンドポイントをテーブルにマッピングするには、「モデルファイルの構文」の手順に従ってくださいエンドポイントをテーブルにマッピングする際の基本的なフォーマットについては、「モデルファイルの作成」の例を参照してください。
- Modelファイルを環境に合わせて変更することができます。例えば、ドライバが HTTP ステータスコードを処理する方法や、GETリクエストの異なる設定などです。 REST API データソースの場合、例示されているモデルファイルのように、POSTリクエストや認証オブジェクトは必要ありません。
以下のタスクのいずれかを実行します。
- クエリパラメータとして設定されたAPIキー認証を使用する
  APIキー認証を使用するには、これらの手順を完了する前に、データソースがクエリパラメータとしてAPIキーを渡すことをサポートしていることを確認してください。
  
  APIキー認証を使用するには、APIキーを直接ホスト URL に追加します。
  例えば：この例 URL では、<your_api_key> を API キーに置き換えます。
  https://api.example.com/resource?apikey=<your_api_key>
  
  認証情報で、認証方法として「なし」を選択します。
  ヘッダーパラメータとして設定されたAPIキー認証を使用する
  ヘッダーパラメータとして設定されたAPIキー認証を使用するには、以下の手順に従います。
  
  追加のプロパティフィールドに、以下のパラメータを入力します。 <your_api_key> をAPIキーに置き換えてください。
  AuthenticationMethod=HttpHeader;SecurityToken=ApiKey<your_api_key>
  
  認証情報で、認証方法として「なし」を選択します。
  他の認証方法（Basic、None、またはBearer Token）を使用する
  他の認証方法を使用するには、この手順を完了します。
  
  認証情報で、認証方法（ベーシック認証、なし、またはベアートークン）を選択し、必要な認証情報を入力します。
接続にカスタム SSL 証明書が必要な場合は、 SSL 証明書フィールドに証明書を入力します。
作成をクリックして、データ・ソース環境への接続を追加します。