1 REST APIについて

この章では、資格証明およびキーストアの管理のためのOracle Fusion Middleware Representational State Transfer (REST) APIの概要を示します。

次のトピックが含まれています:

REST APIの概要

資格証明およびキーストアを管理するREST APIは、ドメインおよびWebサービスの資格証明ストア、キーストアおよびトラスト・ストアを作成および構成するためのエンドポイントを提供します。

RESTエンドポイントには、Webブラウザとクライアント・アプリケーションからアクセスできます。

Oracle WSM RESTエンドポイントは、次のような言語で開発されたRESTクライアント・アプリケーションで使用することもできます。

JavaScript
Ruby
Perl
Java
JavaFX

REST APIを使用する前に、次の項で説明するいくつかの重要なコンセプトを理解する必要があります。

セキュリティ・ストアのURL構造

特定のURL構造を使用してセキュリティ・ストアを管理できます。

セキュリティ・ストアの管理には、次のURLを使用します。

http(s)://host:port/idaas/contextpath/admin/v1/resource

各項目の意味は次のとおりです。

host:port: Oracle Fusion Middlewareを実行しているホストおよびポート。
contextpath: RESTリソースのコンテキスト・パス。この値は、ドメイン全体に適用されるリソース(キーストア管理や資格証明管理のリソースなど)の場合はplatform、特定のWebサービスに適用されるリソース(信頼管理のリソースなど)の場合はwebserviceに設定できます。
resource: RESTリソースを定義する相対パス。詳細は、「REST APIリファレンス」を参照してください。Web Application Definition Language (WADL)ドキュメントにアクセスする場合は、application.wadlを指定します。

RESTを使用したOracle WSMインスタンスの作成と管理

Oracle WSM RESTエンドポイントは、Oracle WSMインスタンスを作成および管理するための標準メソッドをサポートします。

RESTメソッド	タスク
`GET`	RESTリソースに関する情報を取得します。
`POST`	RESTリソースを追加します。
`PUT`	RESTリソースを更新します。
`DELETE`	RESTリソースを削除します。

RESTリソースの認証

Oracle Fusion Middleware RESTリソースにHTTPでアクセスできますが、Oracle WebLogic Server管理者のユーザー名とパスワードを入力する必要があります。

たとえば、cURLを使用して認証するには、-u cURLオプションを使用してユーザー名とパスワード(たとえば、SmithとPassword)を渡します。

curl -i -X GET -u Smith:Password http://myhost:7001/idaas/platform/admin/v1/keystore

リクエスト本文でデータを送信しないPOSTおよびDELETEメソッドでは、キーストアまたはキーがパスワードで保護されている場合、カスタム・ヘッダーで、Base64で暗号化されたキーストアおよびキーのパスワードを渡す必要があります。次に例を示します。

curl -i -X DELETE -u Smith:Password -H keystorePassword:Base64EncodedPassword -H keyPassword:Base64EncodedPassword  http://myhost:7001/idaas/platform/admin/v1/keystoreservice/certificates?"stripeName=myStripe&keystoreName=myKeystore&keyAlias=myAlias"

HTTPメソッドのHTTPステータス・コード

このトピックで説明するリソースの操作に使用するHTTPメソッドは、次のHTTPステータス・コードのいずれかを返します。

HTTPステータス・コード	説明
200 OK	リクエストが正常に完了されました。ステータス200は、`GET`または`POST`メソッドが成功した場合に返されます。
201 Created	リクエストが完了し、新規のリソースが作成されました。レスポンスには、新規作成されたリソースの正規URIを含むロケーション・ヘッダーが含まれます。 201ステータスは、レスポンスが返されるより前に完了した同期リソース作成または非同期リソース作成から返されます。
202 Accepted	リクエストの処理は承認されましたが、処理がまだ完了していません。実際の処理が発生するときにリクエストが拒否される可能性もあるため、リクエストが実際に実行されるかどうかは未定です。非同期(`__detached=true`)リソース作成を指定する(アプリケーションのデプロイ時など)、または更新を指定する(アプリケーションの再デプロイ時など)場合は、操作がまだ進行中でも202が返されます。`__detached=false`の場合、基礎となる操作が妥当な時間内で完了しない場合に202が返されることもあります。レスポンスには、ジョブが完了するタイミングを判定するためにクライアントがポーリングするジョブ・リソースのロケーション・ヘッダーが含まれます。また、ジョブの現在のステータスを含むエンティティを返します。
400 Bad Request	情報が欠落しているか無効なため(たとえば、入力フィールドに検証エラーがある、必須の値が欠落しているなど)、リクエストを処理できませんでした。
401 Unauthorized	リクエストは承認されません。このリクエストに含まれていた認証資格証明が欠落しているか無効です。
403 Forbidden	ユーザーを認証できません。このリクエストを実行する権限がユーザーにありません。
404 Not Found	リクエストに、存在しないリソースURIが含まれています。
405 Method Not Allowed	リクエストで指定されたHTTP動詞(`DELETE`、`GET`、`POST`、`PUT`)が、このリクエストURIではサポートされていません。
406 Not Acceptable	このリクエストで指定されたリソースは、リクエストのAcceptヘッダーにあるメディア・タイプのいずれかに対応する表現を生成できません。たとえば、クライアントのAcceptヘッダーではXMLを返すようにリクエストされていますが、リソースはJSONしか返しません。
415 Not Acceptable	クライアントのContentTypeヘッダーが正しくありません(たとえば、クライアントがXMLでリクエストを送信しようとしたが、リソースはJSONしか受け付けないなど)。
500 Internal Server Error	サーバーで予期しない状態が発生し、リクエストを処理できませんでした。
503 Service Unavailable	サーバーが一時的な過負荷またはメンテナンス状態にあるため、サーバーがリクエストを処理できません。Oracle WSM REST Webアプリケーションは現在実行されていません。