メインコンテンツまでスキップ

APIM Developer Portal User Guide

はじめに​

このガイドでは、APIM開発者ポータル内でユーザーが実行できるタスクの詳細について説明します。

マイアプリケーションの作成​

まず、ユーザーはアプリケーションを作成する方法を知る必要があります。

アプリケーションとは何ですか？​

アプリケーションは、ユーザーのサービスまたはシステムを開発または運用するためのものです。これを通じて、ユーザーはAPIキー、API URLを発行し、APIへのアクセスをリクエストし、Swaggerを介してAPIをテストできます。

アプリケーションを作成する手順​

  • グローバルメニュー > アプリケーション > マイアプリケーションに移動します。

  • マイアプリケーション画面で「作成」ボタンをクリックします。

  • 新しいアプリケーションの名前を入力します（韓国語、英語、スペースが許可されています）。
  • 「確認」をクリックしてアプリケーションを作成します。

マイアプリケーション​

これはユーザーのワークスペースです。メンバーを追加したり、APIアクセスをリクエストしたり、Swaggerを介してテストしたり、APIキーを管理したりできます。

画面コンポーネント：

  • Basic Information: アプリケーション名とアイコンを設定し、未使用のアプリケーションを削除します。
  • API KEY: API呼び出し中の認証に使用されます。作成時に自動的に発行され、アプリの管理者によって再発行できます。
  • API Usage: APIへのアクセスをリクエストするために、選択し、使用意図を説明します。承認されると、API URLを受け取ります。
  • Member Management: メンバーを追加し、アプリの管理者権限を割り当てます。
  • IP/Referer Whitelist: 特定のIPまたはホワイトリストに登録されたリファラーのみにAPI呼び出しを制限し、他はブロックします。

My Application - 基本情報​

アプリケーション名とアイコンを管理し、オプションでアプリケーションを削除します。

主なポイント:

  • 「基本情報」に移動して詳細を表示します。
  • アプリケーション名、AppID、および作成日を確認します。
  • アプリケーション名を編集します。
  • アプリケーションアイコンを設定または変更します。
  • 変更を保存します。アプリケーション管理者はアプリケーションを削除できます。

My Application - API KEY​

これは、APIを呼び出す際の認証のためのAPI KEYを指します。アプリケーションを作成する際に自動的に発行され、アプリケーション管理者は再発行できます。

危険

API KEYはAPIを呼び出す際に適用する必要があります。そうしないと、認証がないためAPI呼び出しは失敗します。

主なポイント:

  • API KEYメニューにアクセスします。
  • アプリケーション作成時に発行された初期API Keyを表示します。
  • APIを呼び出す際は、HTTPリクエストヘッダーに次のように設定します:
x-apim-key: "xxxxxxxx"

My Application - API使用​

使用したいAPIを選択し、APIを使用する目的を入力して、APIの使用をリクエストします。リクエストが承認されると、APIを呼び出すためのAPI URLが受け取れます。

APIを使用するには、以下の手順に従ってください:

  • メニューから「API使用」画面に移動します。
  • 「追加」ボタンをクリックして、使用をリクエストしたいAPIを選択します。

  • 「使用承認リクエスト」ポップアップで、チェックボックスにチェックを入れて使用するAPIを選択します。複数選択が可能です。
  • 使用目的/説明を入力します。
  • 「確認」をクリックしてリクエストを送信します（ステータスは「保留中」に設定されます）。

上記はAPI使用リクエスト後の画面で、API使用リクエストのステータスが「保留中」と表示されています。API使用リクエスト通知がAPIマネージャーに送信されたため、承認を待ちます。

APIマネージャーが承認すると：

  • ステータスが「承認済み」に変更されます。
  • API呼び出しに使用できるAPI URLが発行されます。
  • Swaggerを使用してAPIをテストできます。
  • リクエストをキャンセルするか、「承認済み」のAPIを削除できます。
危険

APIを削除すると、発行されたAPI URLは無効になります。

APIテスト - Swagger UI​

APIドキュメントはSwaggerに基づいて提供され、API呼び出しテストはSwagger > 試してみる > 実行を通じて行われます。

APIをテストするための手順は以下の通りです：

  • API KEY画面からAPI KEYをコピーします。
  • Swagger UIで「認証」をクリックし、API KEYを入力します。
  • APIメソッドとパスを選択します。
  • 「試してみる > 実行」をクリックします。
危険

APIを呼び出す際にはAPI KEYを適用する必要があります。そうしないと、認証失敗によりAPI呼び出しが失敗します。

マイアプリケーション - メンバー管理​

この機能は、アプリケーションにメンバーを追加し、追加されたメンバーにアプリ管理者権限を付与するものです。アプリケーションを最初に作成したユーザーには、デフォルトでアプリ管理者権限が付与されます。

以下の手順に従ってください：

  • 「メンバー管理」メニューに移動します。
  • 元の作成者には自動的にアプリ管理者の権限が付与されます。
  • 「追加」をクリックしてメンバーを追加します。
危険

APIM開発者ポータルに登録したメンバーのみが追加できます。追加されるユーザーには、まずAPIM開発者ポータルに登録するよう指示してください。

「メンバー追加」ポップアップで、以下の手順に従うことができます：

  • 追加するユーザーを1人以上選択します。
  • 「確認」をクリックしてプロセスを完了します。
危険

追加したいメンバーのユーザーIDを確認して、間違ったユーザーを追加しないようにしてください。

メンバーの追加が完了すると、画面に以下のコンポーネントが表示されます：

  • 追加されたメンバーを確認できます。
  • 追加されたメンバーに「アプリ管理者」権限を付与できます。
  • 追加されたメンバーを再度「メンバー」から除外することもできます。
危険

アプリ管理者の権限には以下が含まれます：

  • アプリ名/アイコンの変更
  • アプリケーションの削除
  • APIキーの再発行
  • APIアクセスのリクエストまたはキャンセル
  • メンバーおよび管理者ロールの管理

マイアプリケーション - IP/リファラーホワイトリスト​

API呼び出しは、限られたオリジンからのIP/リファラーのホワイトリストに対してのみ許可されており、その他の呼び出しはブロックされます。

IP/リファラーをホワイトリストに追加する手順は以下の通りです：

  • 「IP/リファラーのホワイトリスト」メニューに移動します。
  • 「追加」をクリックしてエントリを挿入します。
  • IPv4 CIDR形式（例：192.168.0.0/24）を入力します。
  • エントリの説明を追加します。
  • 「アクティブ」にチェックを入れてルールを有効にします。変更を保存することを忘れないでください。
  • IPv4 CIDRエントリを保存します。「アクティブ」とマークされた項目のみが適用されます。
  • 必要に応じてエントリを削除してください。削除後に保存してください。