1. Oracle EssbaseのREST API
  2. cURLの使用

cURLの使用

このドキュメント内の例では、cURLを使用して、Essbase REST APIへのアクセス方法を実際に示します。cURLは、HTTPリクエストおよびその他のリクエストの実行に使用できるコマンドライン・データ転送ツールです。

タスク1: cURLをインストールする

サーバーに安全に接続するには、SSLをサポートしているバージョンのcURLをインストールし、Verisign CA証明書に対して認証するSSL認証局(CA)証明書ファイルまたはバンドルを提供する必要があります。認証の詳細は、「認証」を参照してください。

次の手順では、Windows 64ビット・システム上にcURLをインストールする方法を実際に示します。

  1. ブラウザで、cURLホーム・ページ(https://curl.se/download.html)に移動し、左側のナビゲーション・メニューで「ダウンロード」をクリックします。

  2. cURLの「Releases and Downloads」のページで、ご使用のオペレーティング・システム用のcURLソフトウェアのSSL対応バージョンを見つけ、そのZIPファイルをダウンロードするためのリンクをクリックし、そのソフトウェアをインストールします。

  3. cURLのCA証明書のページ(https://curl.se/docs/caextract.html)に移動し、cURLをインストールしたフォルダにca-bundle.crt SSL CA証明書バンドルをダウンロードします。

  4. コマンド・ウィンドウを開き、cURLをインストールしたディレクトリに移動し、cURL環境変数CURL_CA_BUNDLEをSSL認証局(CA)の証明書バンドルの場所に設定します。例:

    C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt

これでcURLを使用してリクエストを送信する準備ができました。

タスク2: cURLの環境変数を設定する

コマンド・ウィンドウで、cURL環境変数CURL_CA_BUNDLEをローカルのCA証明書バンドルの場所に設定します。例:

C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt

cURLを使用したCA証明書検証の詳細は、https://curl.se/docs/sslcerts.htmlを参照してください。

タスク3: cURLを起動する

cURLを起動し、必要に応じて、次の表で定義されている1つ以上のコマンドライン・オプションを指定して、その実行を指示します。

cURLオプション 説明
-d, --data @file.json ローカル・マシン上の、リクエスト本体を含むJSON形式のファイルを特定します。または、-d"{id=5,status='OK'}を指定してリクエスト本体を渡すこともできます。
-F, --form @file.json ローカル・マシン上のJSON形式のフォーム・データを特定します。
-H --header, -I -include, and -X --request <method> 次のいずれかまたは両方を定義します。

  • リクエスト・ドキュメントのコンテンツ・タイプ

  • アイデンティティ・ドメインを特定するカスタム・ヘッダーX-ID-TENANT-NAME

-i レスポンス・ヘッダー情報を表示します。
-u, --user <username>:<password> Essbaseのユーザー名とパスワードを指定します。cURLコマンドごとにこれらを指定する必要をなくすには、Cookieの実装か変数の使用を検討してください。https://curl.se/docs/http-cookies.htmlを参照してください。
-X リクエストのタイプ(たとえば、GET、POST)を示します。

例:

curl -i -X GET -u username:password https://myserver.example.com:9001/essbase/rest/v1/about