RESTクライアントの操作
REST APIはHTTPメソッドを使用してコンテンツを送受信するため、HTTPメッセージの送受信をサポートする任意のプログラミング言語またはツールを使用して、REST APIをテストできます。 まず、HTTPリクエストを作成するためのツールを選択します。
ノート:
Oracle REST APIはOData (Open Data Protocol)に準拠していません。RESTクライアントの選択に関する考慮事項
Fusion Procurementと対話するクライアントの中から、次のようなクライアントを選択できます:
-
PostmanやAdvanced REST Clientなどのスタンドアロン・クライアント
-
接続アプリケーションのクライアント
ノート:
Visual Builder Studioを使用してREST APIにアクセスする場合は、「サービス仕様からのサービス接続の作成」を参照してください。 Oracle Integration Cloudを使用してREST APIにアクセスするには、「ドキュメントに記載されているMetadataを使用しないで外部REST APIを使用するためのRESTアダプタの構成」を参照してください。 RESTリソースにアクセスするための独自のクライアントを作成することもできます。 Javaプログラミング言語を使用してクライアントを構築するには、「JAX-RSクライアントAPIを使用したRESTリソースへのアクセス」を参照してください。 -
cURLコマンドライン・ユーティリティ
クライアントを使用して、次のタスクを実行できます:
-
REST APIアカウントのユーザー名、パスワードおよびリクエストURLをテストします。
-
RESTリソース、属性およびパラメータについてさらに学習するには、
view
およびdescribe
アクションを実行します。 -
収集された情報を使用して、様々なタイプのHTTPリクエスト(レコードの作成、更新または削除など)を構成および送信します。
cURLを使用してHTTPリクエストを送信する方法
この例では、URL構文を使用してデータを転送する一般的なコマンドライン・ユーティリティであるcURLを使用して、RESTサービスにリクエストを送信します。ほとんどのUNIX、WindowsおよびMacintosh環境では、cURLを使用できます。 詳細は、「WindowsへのcURLコマンドライン・ツールのインストール」を参照してください。
次の表に、RESTサービスに使用できる、一般的に使用されるcURLオプションを示します。
オプション | 説明 |
---|---|
-user |
サーバー認証のユーザー名とパスワードを指定します。 |
-d |
指定したデータ(JSONリクエスト本文)をサーバーに送信します。 データを@記号で開始する場合、データの読取り元のファイル名を@の後に付ける必要があります。 |
-H |
リクエストに追加のHTTPヘッダーを指定します。 複数のヘッダーを指定するには、各ヘッダーの前に
次に例を示します。
|
-output |
|
-X |
HTTPサーバーとの通信時に使用するリクエスト・メソッドを指定します。 デフォルトのメソッドはGETです。 |
次の表に、cURLを使用したGET、PATCHおよびPOST操作の例を示します。
操作 | cURLコマンドの例 |
---|---|
|
|
|
|
|
|
クライアントを使用したHTTPリクエストの送信方法
スタンドアロン・クライアント、サードパーティのブラウザ拡張機能、または拡張RESTクライアントなどのアドオンを使用して、HTTPリクエストを送信できます。 次の表に、クライアントを使用したGET、POSTおよびPATCH操作の例を示します。
操作 | レスポンス/ペイロードの例 |
---|---|
GET: 1人の調達エージェントを取得します。 リクエストURL : |
|
POST: 1つの調達エージェントを作成します。 リクエストURL : |
|
パッチ: 調達エージェントを更新します。 リクエストURL : |
|