Learn About the Oracle API Platform Cloud Service REST APIs

Oracle API Platform Cloud Serviceは、特定のタスクの自動化に使用できるREST Webサービスを提供します。

The REST APIs included in Oracle API Platform Cloud Service are:

• 管理サービス: ゲートウェイ・アーティファクトの管理、ポリシー情報の作成と取得、ユーザー・プリファレンスの取得と更新、ユーザーに対するロールと権限付与に関する情報およびその他の管理操作を提供します。
• アナリティクス: アクティブなアプリケーション、失敗、リクエストの合計数、アクティブなゲートウェイ、時系列データとしてのリクエストおよびレスポンスなどの統計およびパフォーマンス情報を取得する操作を提供します。
• コンシューマ・サービス: アプリケーションの作成と削除、アプリケーション情報の更新、アプリケーションに対する権限の追加または削除、開発者ポータル構成設定の管理、ユーザー・プリファレンスの設定または削除などをサポートする操作を提供します。
• ゲートウェイ・コントローラ: ノードおよびセキュリティ・プロファイルの構成に関連する操作を提供します。
• 管理サービス: API、API権限、アプリケーション、デプロイメント、API権限の作成および管理を、他の操作で行うための操作を提供します。

The Management Service is a REST API that you can use to create and deploy APIs in Oracle API Platform Cloud Service.

Oracle API Platform Cloud Service管理APIを使用した新規APIの作成

RESTを使用してAPIを作成するには、Oracle API Platform Cloud Service管理APIを使用します。

管理REST APIを使用してAPIを作成するには、スクリプトでRESTコマンドを実行する前に、cURLまたはプリファレンスのRESTクライアントを使用してAPIマネージャ・ロールを持っていることをテストします。

1. エディタで、次の情報を使用してcURLリクエストの基本的なJSONテンプレートを作成します。

   {
       "name": "YOUR_API_NAME",
       "version": "YOUR_API_VERSION",
       "implementation":
       {
           "policies": [
           {
               "id": "1",
               "type": "o:ApiRequest",
               "version": "1.0",
               "draft": true,
               "config":
               {}
           },
           {
               "id": "2",
               "type": "o:ServiceRequest",
               "version": "1.0",
               "draft": true,
               "config":
               {}
           },
           {
               "id": "3",
               "type": "o:ServiceResponse",
               "version": "1.0",
               "config":
               {}
           },
           {
               "id": "4",
               "type": "o:ApiResponse",
               "version": "1.0",
               "config":
               {}
           }],
           "executions":
           {
               "request": ["1", "2"],
               "response": ["3", "4"]
           }
       }
   }

   JSONテンプレートでは、nameはAPI名、versionはAPIバージョンです。このテンプレートには、API名、バージョン、ドラフト・モードのAPIリクエストおよびサービス・リクエスト・ポリシー、サービス・レスポンスおよびAPIレスポンス・ポリシーなど、Oracle API Platform Cloud ServiceでAPIを作成するために必要な最小限必要な情報が含まれています。

2. By using cURL or your REST client, make a POST request to the https://YOUR-API-PCS-INSTANCE-URL/apiplatform/management/v1/apis endpoint, where YOUR-API-PCS-INSTANCE-URL is the URL of your Oracle API Platform Cloud Service instance.
3. リクエストおよびレスポンス本文からレスポンス・ヘッダーを確認します。

   HTTP/1.1 200 OK 
   Server: Oracle-Traffic-Director/12.2.1.0.0
   Date: Tue, 19 Jul 2016 13:27:08 GMT
   Content-Length: 30
   Content-Type: application/json
   X-oracle-dms-ecid: dd439614-7d4f-47ad-a1ea-a25a74ec9403-0000032d
   X-oracle-dms-rid: 0:1
   Via: 1.1 otd_opc
   Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

   サーバーからのレスポンス本文もJSON形式です。

   {
     "id": "101",
     "iterationId": "1"
   }