REST API の管理

ステップ 1: Application メニューで API Manager > Rest APIs に移動し、Create をクリックします。

ステップ 2: 必要な情報を入力します。

Name: API 名。
Title: API のタイトル。
Base Path: API 公開後にクライアントがリクエストを送信するパス。
Target Endpoint: 顧客に提供される現在利用可能な API のエンドポイント。
Target Security: API の認証情報。
Security Method: クライアントがこの API を使用する際の認証方法。現在、Basic Authentication、OAuth、API Key の 3 つの方法が利用可能です。

注意: セキュリティ方法は作成後に変更できないため、この情報を宣言する際は慎重に行ってください。

ステップ 3: OK をクリックして REST API を初期化します。

Create ボタンが無効になっている場合は、API Management サービスパッケージを確認してください。Pilot パッケージでは、システムに宣言できる API は最大 2 つまでです。

また、宣言する API のリストがある場合は、Utility セクションに移動して複数の API を同時に宣言できます。

手順は以下の通りです。

ステップ 1: Application メニューで Utility > Import API を選択します。

ステップ 2: JSON テキストフィールドに API データを入力します。入力は JSON 形式である必要があります。

必要な入力形式は以下の通りです。

Copy[
    {
        "name": "",
        "title": "",
        "base_path": "",
        "target_endpoint": "",
        "security_method": ""
    }
]

ステップ 3: Parse をクリックし、次に Import をクリックします。

正常に宣言された API は Import APIs テーブルに表示されます。エラーが発生した場合は、Import Error セクションにエラーメッセージが表示されます。

REST API の情報を変更するには、以下の手順に従ってください。

ステップ 1: Rest APIs で変更する REST API を選択し、Edit をクリックします。

ステップ 2: 新しい情報を入力し、OK をクリックします。

以前に宣言した REST API をシステムから削除する場合は、REST API がどの製品にも関連付けられていないことを確認してください。REST API を製品からデタッチするには、製品管理セクションの手順に従ってください。

REST API を削除するには、以下の手順に従ってください。

ステップ 1: Rest APIs で削除する REST API を選択し、Remove API をクリックします。

ステップ 2: 確認ポップアップで Yes をクリックして続行します。

リクエストまたはレスポンスに指定した値でフィールドを追加/編集したい場合は、API Management の Transformer 機能を使用できます。

開始するには、以下の手順に従ってください。

ステップ 1: Rest APIs で変更する REST API を選択し、Edit をクリックして Advanced タブを選択し、Transformations をクリックします。

ステップ 2: Request Transformer / Response Transformer にチェックを入れ、Raw View をクリックして、各リクエスト/レスポンスで変更したい情報を入力します。

例: リクエスト Transformer の特定フィールドを削除する場合: リクエストの body / headers / query string 内の 1 つ以上のフィールドを削除したい場合は、変更したいデータをそれぞれのセクションに入力します。

この機能を使用するには、以下の手順に従ってください。

ステップ 1: Application メニューで API Manager > Rest APIs に移動し、API を選択して Edit をクリックします。

ステップ 2: Advanced タブを選択し、Security タブを選択して Use CORS チェックボックスにチェックを入れます。

ステップ 3: 情報を入力します。

Access-Control-Allow-Origin: API へのアクセスを許可する IP、ドメインなどを入力します。リストに記載されたブラウザのみが API にアクセスできます。空白の場合は、他のすべてのドメインからの API アクセスを許可することを意味します。