PowerShellにおけるネットワークAPIの詳細

PowerShellは、Windows環境で広く利用されている強力なスクリプト言語であり、ネットワークAPI、特にREST APIとの連携に非常に適しています[1][4]。

主なネットワークAPI操作

PowerShellでは、主に以下のコマンドレットを利用してWeb APIと通信します。

Invoke-RestMethod REST API（HTTP/HTTPSベースのWebサービス）と通信し、構造化データ（JSONやXMLなど）を直接オブジェクトとして受け取ることができます。GET、POST、PUT、DELETEなどのHTTPメソッドを指定してリクエストを送信できます[3][4]。
Invoke-WebRequest WebページやWebサービスへのHTTP/HTTPSリクエストを送信し、応答をHTMLやテキストとして取得します。ファイルのダウンロードやWebスクレイピングにも利用できます[2][5]。

基本的な使い方

GETリクエスト

$apiUrl = 'https://example.com/api/resource'
$response = Invoke-RestMethod -Uri $apiUrl -Method Get
$response

この例では、指定したAPIエンドポイントにGETリクエストを送り、結果をオブジェクトとして取得します[4]。

POSTリクエスト

$apiUrl = 'https://example.com/api/resource'
$params = @{
    'key1' = 'value1'
    'key2' = 'value2'
}
$response = Invoke-RestMethod -Uri $apiUrl -Method Post -Body $params -ContentType 'application/json'
$response

POSTリクエストでは、パラメータをハッシュテーブルやJSON形式で渡し、必要に応じて-ContentTypeを指定します[4]。

詳細オプション

プロキシのバイパス -NoProxyパラメータを使うと、環境で設定されたプロキシを無視して直接リクエストを送ることができます[2]。
タイムアウト設定 -OperationTimeoutSecondsでリクエストのタイムアウト秒数を指定できます[2]。
リダイレクト制御 -MaximumRedirectionでリダイレクトの最大回数を設定できます[3]。
認証 APIによってはBearerトークンなどの認証が必要です。ヘッダーにトークンを追加することで認証付きリクエストが可能です[5]。

$header = @{
    "Authorization" = "Bearer "
    "Content-Type"  = "application/json"
}
$response = Invoke-RestMethod -Uri $apiUrl -Headers $header -Method Get