APIキー

Prev Next

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

APIキー発行画面では、作成したキーの発行履歴と使用可否を一目で確認できます。

APIキー

CLOVA Studio APIは、権限を持つユーザーのみが呼び出せるように、識別ツールである APIキーをアカウントごとに発行します。APIキーは、API呼び出し時に認証情報として渡すリクエストヘッダのパラメータとして使用します。そのため、CLOVA Studio APIを使用するには、まず APIキーを発行する必要があります。

APIキー発行

APIキーは、NAVERクラウドプラットフォームコンソールの CLOVA Studioで発行できます。発行方法は次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左側の APIキーメニューをクリックします。
  3. APIキー画面が表示されたら、発行する APIキーのタブメニューをクリックし、発行ボタンをクリックします。
    • テスト APIキー: [テスト] タブメニューをクリック > [テスト APIキー発行] ボタンをクリック
      • サービスアプリを除く CLOVA Studio API呼び出し時に利用可能
      • NAVERクラウドプラットフォームのメインアカウント基準で最大10個まで作成可能
    • サービス APIキー: [サービス] タブメニューをクリック > [サービス APIキー発行] ボタンをクリック
      • 登録完了済みのサービスアプリにおける CLOVA Studio API呼び出し時に利用可能
      • NAVERクラウドプラットフォームのメインアカウント基準で最大10個まで作成可能
  4. API keyコピーのポップアップが表示されたら、 [削除] ボタンをクリックします。
  5. [コピー] ボタンをクリックし、[完了] ボタンをクリックします。
注意

APIキーコピーのポップアップを閉じた後は、発行した APIキーを確認できません。そのため、発行時には必ず別途の安全な場所に保管してください。

旧バージョンの APIキー確認(Deprecated)

2025年1月以前に発行したテストアプリまたは登録したサービスアプリに対して発行した APIキーを確認できます。

テストアプリ

テストアプリの APIキーを確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左側の APIキーメニューをクリックします。
  3. APIキー画面が表示されたら、 [Deprecated] メニューをクリックします。
  4. i_clovastudio-more(1){height="" width=""}をクリックした後、コピーメニューをクリックして APIキーを確認します。
  5. 画面右上の [API Gatewayキーを見る] ボタンをクリックします。
  6. API Gatewayキーのポップアップが表示されたら、API Gatewayキーを確認します。
注意

API Gatewayキーを再発行すると、直ちに以前のキーで利用していたテストアプリやサービスアプリの利用ができなくなります。
そのため、影響を確認して事前措置を講じた後、どうしても必要な場合にのみ行ってください。

サービスアプリ

サービスアプリの APIキーを確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左側のサービスアプリの申し込みメニューをクリックします。
  3. サービスアプリのコードを見るボタンをクリックします。
  4. [既存] タブメニューをクリックしてサービスアプリの旧バージョン APIキーを確認した後、API Gatewayキーを確認します。
  • APIキー: X-NCP-CLOVASTUDIO-API-KEY
  • API Gatewayキー: X-NCP-APIGW-API-KEY
参考

サービスキーが必要な場合は、サービスアプリを新規に申し込んで発行する必要があります。

APIセキュリティ設定

APIキーが第三者に漏洩した場合、CLOVA Studioリソースを不正に利用するなどセキュリティ上の問題が発生する可能性があるため、適切な事前対策と対応が必要です。

APIキーの削除と再発行

APIキーを使用していない場合や第三者による不正使用が疑われる場合は、発行した APIキーを削除してから再発行する必要があります。削除および再発行方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > AI Services > CLOVA Studioメニューを順にクリックします。
  2. 画面左側の APIキーメニューをクリックします。
  3. APIキー画面が表示されたら、削除する APIキーがあるタブメニューをクリックします。
  4. 削除する APIキーの i_clovastudio-more(1){height="" width=""}をクリックした後、削除メニューをクリックします。
  5. APIキー削除のポップアップが表示されたら、 [削除] ボタンをクリックします。
  6. APIキー発行を参照して、新しい APIキーを発行します。
注意

削除した APIキーは無効なキーとして認識されるため、API呼び出しに使用できなくなります。
そのため、影響を確認して事前措置を講じた後、どうしても必要な場合にのみ行ってください。