AI·NAVER API の概要

Prev Next

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

AI-NAVER APIサービスは、NAVERクラウドプラットフォームの様々な人工知能サービスを簡単に構築し、安定的に運用できるように APIの形式で提供します。
AI-NAVER APIサービスを利用するには、Application情報を登録して管理する手続きが必要です。

以下の内容をご確認し、手順に沿ってご利用ください。

ご利用の申し込み

NAVERクラウドプラットフォームの AI-NAVER APIサービスを初めて利用する場合は、NAVERクラウドプラットフォームコンソールで AI-NAVER APIサービス利用規約に同意する必要があります。AI·NAVER APIサービス利用規約は、ユーザーの権利および義務、利用制限および利用料金、特約条件などに対する内容が含まれているため、サービスを利用される前に必ずご確認ください。

参考

既に AI・NAVER APIの他のサービスを利用中の場合は、サービス利用規約に同意するプロセスは省略されるため、Application登録に移動します。

AI·NAVER APIサービス利用規約に同意する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールにアクセスします。
  2. コンソール画面右上の リージョン＆プラットフォームをクリックします。
  3. 利用中のリージョンとプラットフォームを選択し、[適用] ボタンをクリックします。
  4. コンソール画面左上の i_menuをクリックします。
  5. Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  6. Applicationメニューをクリックします。
  7. [Application登録] ボタンをクリックします。
  8. AI·NAVER APIサービス利用規約の画面が表示されたら、**AI·Naver APIサービス利用規約に同意します。**をクリックします。
  9. [確認] ボタンをクリックします。
  10. 登録可能な Applicationリストを確認し、次の手続きを行います。
参考

Applicationを登録すると、1つの Applicationごとに固有 Client IDと Client Secret値が作成されます。Client IDと Client Secretの値は、API呼び出し時に HTTPヘッダ値に含まれて送信されます。API呼び出し方法についての詳細は、NAVERクラウドプラットフォーム APIガイドの NAVER連携 API呼び出しをご参照ください。

Application登録

Applicationを登録する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. [Application登録] ボタンをクリックします。
  4. Application名を入力します。
    • 最大20文字まで入力可能
    • サービスの性質により、Application名が画面に表示される可能性があるため、10文字以内での入力を推奨
  5. Service選択領域で使用するサービスをクリックして選択します。
    • [サービスの説明/料金のご案内] ボタン: クリック時に NAVERクラウドプラットフォームポータルのサービスの紹介画面に移動
    • [開発ガイド] ボタン: クリック時に当該サービスのご利用ガイドに移動
  6. サービス環境登録領域で Applicationのサービス環境を入力します。
    • Webサービス URL
      • http://で始まるウェブサービス URLを最大10個まで入力可能
      • httpと httpsは区別せず、wwwは除外して入力 例) http://naver.com
      • サブドメインがある場合、代表ドメイン名のみ入力
      • サービス URLと利用する Webの情報が異なる場合、認証に失敗することがあります
      • ハイブリッドアプリは、location.hrefオブジェクト出力値を入力 例) file://ローカル URL
    • Androidアプリのパッケージ名
      • Androidアプリケーションのみ該当し、最大10個まで入力可能
      • 入力したパッケージ名と利用するアプリのパッケージ名が異なる場合、認証に失敗することがあります
    • iOS Bundle ID
      • iOSアプリケーションのみ該当し、最大10個まで入力可能
      • 登録された Bundle IDと利用するアプリの情報が異なる場合、認証に失敗することがあります
    参考
    • 1つの Applicationに発行された Client IDと Secret値を Android、iOS、Web、Windows Appなど様々な環境に適用できます。ただし、APIの使用量はクライアント ID別に合算されます。
    • Webサービス URLは複数追加できるが、Androidアプリパッケージや iOS Bundle IDは一つずつのみ登録できます。
  7. [登録] ボタンをクリックします。

Application情報確認

登録された Applicationリストは NAVERクラウドプラットフォームコンソールの AI·NAVER API > AI·NAVER API > Applicationメニューで確認できます。Applicationリストで Application情報を確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. Application情報を確認します。
    • App名: Application登録時に設定したアプリの名前
    • サービス区分: Application登録時に選択したサービス
    • 当日/当月使用量: サービス別のリアルタイム使用量(UTC+9基準)
    • 限度と通知設定: API呼び出しの利用限度と特定値(%)を超過時、通知設定
    • 登録日: Applicationを登録した日付
  4. [認証情報] ボタンをクリックします。
    ainaverapi_01_ko
  5. 認証情報画面が表示されたら、認証情報を確認します。
    • Application Key
      • Application名: Applicationを区分する名前
      • Client ID(X-NCP-APIGW-API-KEY-ID): 認証に必要な IDでヘッダまたはクエリ文字列に「X-NCP-APIGW-API-KEY-ID」を入力。ainaverapi_05_koクリック時に値コピーが可能
      • Client Secret(X-NCP-APIGW-API-KEY): 認証に必要な SecretKeyパスワードでヘッダまたはクエリ文字列に「X-NCP-APIGW-API-KEY」を入力。ainaverapi_05_ko クリック時に値コピーが可能であり、 [再発行] ボタンをクリックすると値を変更可能
    • サービス環境
      • Webサービス URL: Web SDKを利用するために必要な値
      • Androidアプリパッケージ名: Android SDKを利用するために必要な値
      • iOS Bundle ID: iOS SDKを利用するために必要な値
  6. [確認] ボタンをクリックします。
注意

Client IDと Client Secretが外部に表示されないようにご注意ください。セキュリティ上の懸念がある場合、7.で認証情報を新しい値に再発行します。

Application変更

登録した Application情報を変更する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. 変更する Applicationの [変更] ボタンをクリックします。
  4. 必要な情報を変更した後、 [保存] ボタンをクリックします。

利用管理

登録した Application別利用状況を確認し、課金管理のための様々なオプションを設定できます。

当日/当月の使用量確認

当日の使用量と当月の使用量を確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. Applicationリストで使用量を確認するアプリケーションの当日の使用量と当月の使用量のリアルタイム使用状況を確認します。
    • UTC+9基準
    • 韓国時間を基準に00:00 AMに日別利用量が0に初期化されます
参考

実際当日/当月使用量は反映されるまで約1分かかります。

利用限度設定

高額なサービス利用料金が請求されることを防止するために日別、月別の利用限度を直接設定できます。利用限度を設定する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. Applicationリストで利用限度を変更するアプリケーションの [限度と通知の設定] ボタンをクリックします。
    ainaverapi_02_ko
  4. [限度設定] タブメニューで月別限度値と日別限度値を入力します。
    ainaverapi_03_ko
  5. [保存] ボタンをクリックします。
参考

利用限度を変更した履歴は限度と通知の設定画面の [限度更新履歴] タブメニューで確認できます。

しきい値通知設定

ユーザーが設定した日別/月別限度値の特定使用率を超過した場合、メールまたは SMSで通知を受信できます。
しきい値通知を設定する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. Applicationリストで利用限度を変更するアプリケーションの [限度と通知の設定] ボタンをクリックします。
  4. [限度設定] タブメニューで月別限度設定または日別限度設定項目のチェックボックスをクリックして選択します。
  5. 通知の基準となるしきい値(%)を選択します。
    ainaverapi_04_ko
    • 70%を選択した場合、70%、80%、90%、100%に通知
    • 90%を選択した場合、90%、100%に通知
  6. [保存] ボタンをクリックします。
  7. 通知対象設定を参照して、しきい値通知の設定を受信するアドレスを入力します。
参考

しきい値通知を設定した場合でも、通知対象者を設定しないと通知が受信されません。必ず通知対象者を設定します。

通知対象設定

ユーザーが設定した日別/月別限度値の特定使用率を超過した場合、通知を受ける受取人と受信方法を設定する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. Applicationリストで利用限度を変更するアプリケーションの [限度と通知の設定] ボタンをクリックします。
  4. [通知対象設定] タブメニューをクリックします。
  5. 通知対象の担当者を選択して通知方法を選択し、 [追加] ボタンをクリックします。
    • 新しい担当者を追加するために Cloud Insight(Monitoring)に移動するには、 [通知対象管理] ボタンをクリック
  6. 通知対象者の設定が完了したら、 [保存] ボタンをクリックします。
参考

通知対象の設定では、登録された通知対象担当者のみ選択できます。新しい担当者を登録するタスクは、Cloud Insightの Notification Recipientメニューで実行できます。詳細は、Notification Recipientご利用ガイドの対象者追加をご参照ください。

API呼び出し数確認

API呼び出し数をグラフで確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Usage Statisticsメニューをクリックします。
  3. API呼び出し数を確認するアプリケーション名とサービスを選択して照会期間を設定し、 [照会] ボタンをクリックします。
  4. グラフを確認します。
    • API呼び出し数を成功・失敗グラフで確認
    • サービス別の課金単位による使用量を確認
  5. 照会結果をエクセルファイルでダウンロードする場合、 [ダウンロード] ボタンをクリックします。

解約する

APIで提供されるサービスには、ご利用を解約する手続きが別途存在しません。作成したサービスの Applicationをアンインストールした場合、ご利用を解約したことになります。Applicationをアンインストールする方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、 i_menu > Services > AI·NAVER API > AI·NAVER APIメニューを順にクリックします。
  2. Applicationメニューをクリックします。
  3. アンインストールするサービスの Applicationをクリックし、 [アンインストール] ボタンをクリックします。
  4. アプリアンインストールのポップアップが表示されたら、 [確認] ボタンをクリックします。