RESTクライアントの操作
REST APIはHTTPメソッドを使用してコンテンツを送受信するため、HTTPメッセージの送受信をサポートする任意のプログラミング言語またはツールを使用して、REST APIをテストできます。 まず、HTTPリクエストを作成するためのツールを選択します。
RESTクライアントの選択に関する考慮事項
REST APIと対話する多くのクライアントから、次のようなクライアントを選択できます:
- PostmanやAdvanced REST Clientなどのスタンドアロン・クライアント。
- 接続アプリケーションのクライアント。
- cURLコマンドライン・ユーティリティ。
クライアントを使用して、次のタスクを実行できます:
- REST APIアカウントのユーザー名、パスワードおよびリクエストURLをテストします。
- メタデータにアクセスして、RESTリソース、属性およびパラメータについてさらに学習します。
- 収集された情報を使用して、様々なタイプのHTTPリクエスト(レコードの作成、更新または削除など)を構成および送信します。
cURLを使用してHTTPリクエストを送信する方法
この例では、URL構文を使用してデータを転送する一般的なコマンドライン・ユーティリティであるcURLを使用して、RESTサービスにリクエストを送信します。ほとんどのUNIX、WindowsおよびMacintosh環境では、cURLを使用できます。 詳細は、「WindowsへのcURLコマンドライン・ツールのインストール」を参照してください。
次の表に、RESTサービスに使用できる、一般的に使用されるcURLオプションを示します。
| オプション | 説明 |
|---|---|
| -userまたは-u | username:passwordサーバー認証のユーザー名とパスワードを指定します。 |
| -d | 指定したデータ(JSONリクエスト本文)をサーバーに送信します。 データをアットマーク(@)で開始する場合は、データの読取り元のファイル名が後に続く必要があります。 例: -d@example_request_payload.json |
| -H | リクエストに追加のHTTPヘッダーを指定します。 複数のヘッダーを指定するには、各ヘッダーの前に-Hオプションを付けます。 次に例を示します。
|
| -output | <file>出力を標準出力ではなくファイルに書き込みます。 |
| -X | HTTPサーバーとの通信時に使用するリクエスト・メソッドを指定します。 デフォルトのメソッドはGETです。 |