4.1 Spatial Studio REST APIでのcURLの使用
cURLは、URLリクエストをリモート・サーバーと送受信するために多くのプラットフォームで使用可能な強力なコマンドライン・ツールです。
RESTエンドポイントへのアクセスまたは呼出し時、curlコマンドは特定の形式に従います。
たとえば、Spatial Studioバージョンを取得するための次のリクエストを考えてみます:
HTTP GETリクエスト
curl -k https://localhost:4040/spatialstudio/oauth/v1/softwareVersion \
--header "Authorization: Bearer <MY_TOKEN>"前述のリクエストで使用されるオプションの説明は、次のとおりです:
-k:cURLリクエストがQuick Start Spatial Studioインスタンスで使用される自己署名SSL証明書を受け入れる必要があることを示す場合。–-header: Spatial Studioアクセス・トークンをベアラー・トークン・ヘッダーとしてリクエストに設定する場合。キーワードAuthorization: (コロンと空白を含む)およびBearerは、
-- headerオプションの値全体を二重引用符で囲んで、そのまま入力する必要があることに注意してください。変数<MY_TOKEN>は、連続した1行で指定する必要がある実際のトークン文字列を表します。
リクエストのURLでは、oauth/v1がパス・セグメントとして使用されることに注意してください。誤ってapi/v1を使用した場合、レスポンスはWebアプリケーションのログイン・ページをHTMLで返します。
次の各項では、cURLを使用してREST APIエンドポイントを呼び出す方法について、いくつか例を挙げて説明します: