Classic/VPC環境で利用できます。
API Keysはアプリ開発者などのユーザーが 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名を入力し、 をクリックして項目を検索 |
| ⑦ ソート | リストのページごとに表示する API Key数の設定 |
| ⑧ API Keysリスト | 運用中の API Keyのリストを確認
|
API Key作成
API Gatewayに登録された APIを使用するには、まず API Keyを作成する必要があります。
API Keyを作成する方法は、次の通りです。
- NAVERクラウドプラットフォームコンソールで
> Services > Application Services > API Gatewayメニューを順にクリックします。 - API Keysメニューをクリックします。
- [API Key作成] ボタンをクリックします。
- API Keyの作成情報を入力し、 [保存] ボタンをクリックします。
- 名前: API Keyの名前を入力
- 説明: API Keyの説明を入力
- API Keysリストに作成した API Keyが表示されるか確認します。
API Keyの確認、再作成、コピー
作成した API Keyを確認、再作成、コピーする方法は以下の通りです。
- NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
- API Keysメニューをクリックします。
- API Keysリストで対象 API Keyの [見る] ボタンをクリックします。
- API Keysを見るのポップアップで必要に応じて API Keyを確認、再作成、コピーします。
- Primary Key/Secondary Key: APIを呼び出す時にヘッダーに入れる値
- API Keyを再作成するには
をクリックして、再作成画面のポップアップで内容を確認して [はい] ボタンをクリックします。 - API Keyをクリップボードにコピーするには、
をクリックします。
- [確認] ボタンをクリックします。
API Key変更
API Keyの名前、説明、有効化有無を変更できます。
API Keyを変更する方法は、次の通りです。
- NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
- API Keysメニューをクリックします。
- API Keysリストで変更する API Keyをクリックして選択し、 [変更] ボタンをクリックします。
- API Keyの変更画面で設定情報を変更し、 [保存] ボタンをクリックします。
- ID: 自動作成された API Key IDを表示
- 名前: 作成時に作成した API Keyの名前を変更
- 説明: 作成時に作成した API Keyの説明を追加または変更
- 有効化: API Keyの有効化有無を選択。API Keyを使用しない場合、無効に設定
- API Keysリストに当該 API Keyが変更されているか確認します。
API Key削除
API Keyを削除する方法は、次の通りです。
- NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
- API Keysメニューをクリックします。
- API Keysリストで削除する API Keyをクリックして選択し、 [削除] ボタンをクリックします。
- 削除のポップアップで内容を確認し、 [削除] ボタンをクリックします。
関連付けられた Stageの確認と管理
API Keyと関連付けられた Stageをリストで確認し、API使用量を確認したり、関連付けを解除(サブスクリプションキャンセル)できます。
参考
関連付けられた Stageを確認するには、まず API Keysと Stageを関連付ける必要があります。
API Keyを Stageに関連付ける方法は Stageに API Keyを関連付けして管理をご参照ください。
関連付けられた Stageの確認
API Keyと関連付けられた Stageを確認する方法は以下の通りです。
- NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
- API Keysメニューをクリックします。
- API Keysリストで関連付けられた Stageを確認する API Keyをクリックして選択し、 [関連付けられた Stageを見る] ボタンをクリックします。
- Stage関連付けのポップアップで API Keyのステータスを確認します。
- Product名: 関連付けられた Stageがある Product名を表示
- 説明: Product作成時に入力した説明を表示
- ステータス: 現在の API Keyのステータスを表示
- リクエスト日時: API Keyと Stageの関連付けをリクエストした日時
- 変更日時: API Keyのステータスを変更した日時
- APIの使用量を確認するには対象 Product名をクリックして選択し、 [使用量を見る] ボタンをクリックします。
- Stage関連付けを解除(サブスクリプションキャンセル)するには、対象 Product名をクリックして選択し、 [サブスクリプションキャンセル] ボタンをクリックします。
API使用量の確認
API Keyと関連付けられた Stageの API使用量を確認する方法は以下の通りです。
- NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
- API Keysメニューをクリックします。
- API Keysリストで対象 API Keyをクリックして選択し、 [関連付けられた Stageを見る] ボタンをクリックします。
- APIの使用量を確認する Product名をクリックして選択し、 [使用量を見る] ボタンをクリックします。
- 使用量を見る画面で情報を確認します。
- Product名: API Keyと関連付けられた Stageの Product名を表示
- API名: API Keyと関連付けられた Stageの API名
- Stage名: API Keyと関連付けられた Stageの名前
- 日別呼び出し数/リクエスト処理限度: 日別呼び出し数と Usage Planに設定されている日別リクエスト処理限度の値を表示
- 月別呼び出し数/リクエスト処理限度: 月別呼び出し数と Usage Planに設定されている月別リクエスト処理限度の値を表示
Stage関連付けを解除(サブスクリプションキャンセル)
API Keysと関連付けられた Stageの関連付けを解除(サブスクリプションキャンセル)する方法は以下の通りです。
- NAVERクラウドプラットフォームコンソールで > Services > Application Services > API Gatewayメニューを順にクリックします。
- API Keysメニューをクリックします。
- API Keysリストで対象 API Keyをクリックして選択し、 [関連付けられた Stageを見る] ボタンをクリックします。
- 関連付けられた Stageリスト画面で関連付けを解除する Stageをクリックして選択し、 [サブスクリプションキャンセル] ボタンをクリックします。
- サブスクリプションキャンセルのポップアップで内容を確認し、 [はい] ボタンをクリックします。
- 関連付けられた Stageリストで Stageが削除されていることを確認します。
- 当該 Productの API Keyが承認に設定されたステータスで Stage関連付けを解除すると、Productに関連付けられた API Keysリストで関連 API Key項目も削除されます。
- 当該 Productの API Keyが拒否に設定されたステータスで Stage関連付けを解除すると、Productに関連付けられた API Keysリストで関連項目が削除されず、リクエスト拒否と表示されます。