API Keys

Classic/VPC環境で利用できます。

API Keyは、アプリ開発者などのユーザーがAPI Gatewayに登録されたAPIにアクセスして使用できるように権限を付与するための値です。
API KeysではAPI Keyを作成・管理してStageと接続できます。

API Keysの画面とリスト

API Gatewayの利用のためのAPI Keysメニューの基本的な説明は以下のとおりです。

領域	説明
① メニュー名	現在確認中のメニュー名、運用中のAPI Key数
② 基本機能	API Keyの作成、API Gatewayの詳細情報の確認、ページの更新
③ 修正	運用中のAPI Keyの修正
④ 削除	運用中のAPI Keyの削除
⑤ 接続したStageを見る	API Keyと接続したStageの確認と使用量を見る、サブスクリプションのキャンセル API KeyとStageを接続する方法は、StageにAPI Keyの接続と管理を参照
⑥ 検索ウィンドウ	API Key名を入力して、をクリックして項目を検索
⑦ ソート	リストのページごとに表示するAPI Key数の設定
⑧ API Keysのリスト	運用中のAPI Keyのリストを確認 API Key ID：作成したAPI KeyのID(自動付与) API Key名：API Keyの作成時に設定したAPI Key名 説明：API Keyの作成時に入力したAPI Keyの説明 状態：API Keyの現在の有効化/無効化状態 API Keyの作成時に自動で有効化になり、有効化要否の設定が可能(API Keyの修正を参照) API keys：[見る] のボタンをクリックして作成されたAPI Keyの確認、再作成、コピー

API Keyの作成

API Gatewayに登録されたAPIを使用するためには、まずAPI Keyを作成する必要があります。

API Keyを作成する方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. [API Keyの作成] ボタンをクリックします。
4. API Keyの作成情報を入力して、[保存] ボタンをクリックします。
   • 名前：API Key名を入力
   • 説明：API Keyの説明を入力
5. API Keysのリストに作成されたAPI Keyが表示されるかどうかを確認します。

API Keyの確認、再作成、コピー

作成したAPI Keyを確認、再作成、コピーする方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. API Keysリストで対象のAPI Keyの [見る] ボタンをクリックします。
4. API Keysを見るのポップアップで、必要に応じてAPI Keyの確認、再作成、コピーします。
   • Primary Key/Secondary Key：APIを呼び出す時にヘッダーに入れる値
   • API Keyを再作成するにはをクリックして、再作成画面のポップアップで内容を確認した後、[はい] ボタンをクリックします。
   • API Keyをクリップボードにコピーするにはをクリックします。
5. [確認] ボタンをクリックします。

API Keyの修正

API Key名、説明、有効化の有無を修正できます。
API Keyの修正方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. API Keysリストで修正するAPI Keyをクリックして選択した後、[修正] ボタンをクリックします。
4. API Keyの修正画面で設定情報を修正して、[保存] ボタンをクリックします。
   • ID：自動作成されたAPI Key IDの表示
   • 名前：作成時に作ったAPI Keyの名前の修正
   • 説明：作成時に作ったAPI Keyの説明を追加または修正
   • 有効化：API Keyの有効化の要否を選択 API Keyを使用しないためには無効化に設定
5. API Keysのリストに、そのAPI Keyが修正されたのかどうかを確認します。

API Keyの削除

API Keyの削除方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. API Keysリストで削除するAPI Keyをクリックして選択した後、[削除] ボタンをクリックします。
4. 削除のポップアップで内容を確認し、[削除] ボタンをクリックします。

接続したStageの確認と管理

API Keyと接続したStageをリストで確認して、APIの使用量を確認したり、接続を解除(サブスクリプションのキャンセル)できます。

接続したStageの確認

API Keyと接続したStageを確認する方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. API Keysのリストで接続したStageを確認するAPI Keyをクリックして選択した後、[接続したStageを見る] ボタンをクリックします。
4. Stageの接続ポップアップでAPI Keyの状態を確認します。
   • Product名：接続したStageがあるProduct名を表示
   • 説明：Productの作成時に入力した説明を表示
   • 状態：現在のAPI Keyの状態を表示
   • リクエスト日時：API KeyとStageの接続をリクエストした日時
   • 修正日時：API Keyの状態を修正した日時
   • APIの使用量を確認するには、対象のProduct名をクリックして選択した後、[使用量を見る] ボタンをクリックします。
   • Stageの接続を解除(サブスクリプションのキャンセル)するには、対象のProduct名をクリックして選択した後、[サブスクリプションのキャンセル] ボタンをクリックします。

APIの使用量の確認

API Keyと接続したStageのAPIの使用量を確認する方法は、以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. API Keysのリストで対象のAPI Keyをクリックして選択した後、[接続したStageを見る] ボタンをクリックします。
4. APIの使用量を確認するProduct名をクリックして選択した後、[使用量を見る] ボタンをクリックします。
5. 使用量を見る画面で情報を確認します。
   • Product名：API Keyと接続したStageのProduct名を表示
   • API名：API Keyと接続したStageのAPIの名前
   • Stage名：API Keyと接続したStage名
   • 日別の呼び出し数/リクエスト処理限度：日別の呼び出し数とUsage Planに設定された日別リクエストの処理限度値の表示
   • 月別の呼び出し数/リクエスト処理限度：月別の呼び出し数とUsage Planに設定された月別リクエストの処理限度値の表示

Stageの接続解除(サブスクリプションのキャンセル)

API Keysと接続したStageの接続を解除(サブスクリプションのキャンセル)する方法は以下のとおりです。

1. NAVERクラウドプラットフォームコンソールでServices > Application Services > API Gatewayメニューを順にクリックします。
2. API Keysメニューをクリックします。
3. API Keysのリストで対象のAPI Keyをクリックして選択した後、[接続したStageを見る] ボタンをクリックします。
4. 接続したStageのリスト画面で、接続を解除するStageをクリックして選択した後、[サブスクリプションのキャンセル] ボタンをクリックします。
5. サブスクリプションのキャンセルのポップアップで内容を確認して、[はい] ボタンをクリックします。
6. 接続したStageのリストでStageが削除されたのかどうかを確認します。
   • そのProductのAPI Keyが承認に設定された状態でStageの接続を解除すると、Productに接続したAPI Keysのリストから関連するAPI Keyの項目も削除されます。
   • そのProductのAPI Keyが拒否に設定された状態でStageの接続を解除すると、Productに接続したAPI Keysのリストから関連する項目が削除されず、リクエスト拒否と表示されます。