Application使用ガイド

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

ご利用の前に

Q. Application Serviceとは何ですか？

• CLOVA, Papago, Mapsなど、NAVERの豊富なデータをベースに学習された最新の人工知能サービスを提供するAI ServiceとNAVERで使用する技術をAPIで提供するApplication Serviceを利用し、様々なサービスを簡単に開発できます。

Q. Application Serviceはどのように利用しますか？

• NAVERクラウドプラットフォームコンソールでApplicationを登録すると、Applicationに対する認証キーが発行されます。認証キーを使ってApplicationに登録されたサービスAPIを利用でき、APIリクエストURLはnaveropenapi.apigw.ntruss.comのサブURLで構成されます。サービスごとの詳細なURLは'API使用ガイド'の内容をご参考ください。

Applicationの登録

AI·Naver Serviceで開発するためには、まずApplicationを登録しなければなりません。Applicationが正常に登録されると、Applicationひとつあたり唯一のClient IDとClient Secretの値が作成されます。この値はAPIを呼び出す際、HTTPヘッダの値に含ませて転送すれば呼び出しが可能です。

Application登録の方法

コンソールメニューでAI·NAVER API > AI·NAVER API > Applicationメニューを選択した後、規約に同意してApplicationの登録を行います。

① 規約に同意した後、現れる画面でApplication名を入力します。

• 名前は最大40文字まで使えますが、以降追加されるServiceの性格に合わせて画面に出力されるApplicationの名前が使われる可能性があるので、できれば10文字以内の簡潔な名前が良いです。

② 使用したいServiceを選択します。

• 現在NAVERクラウドプラットフォームを利用して連携できるServiceは、HTTPヘッダにClient IDとSecretの値さえ転送すれば直ちに呼び出して使えるオープンサービスです。

③ サービス環境情報を入力します。

• サービスするApplicationの環境情報を入力します。サービスのURLは複数選択可能であり、AndroidアプリパッケージやiOS Bundle IDはそれぞれ1つずつ登録できます。

  1つのApplicationに発行されたClient IDとSecretの値をAndroid, iOS, ウェブ, WindowsAppなどの様々な環境に適用できます。ただし、APIの使用量はクライアントのアイディ別に合算されるので、ご参考ください。

サービス環境別の詳しい入力の内容

• サービスURL: 'http://'で始まるウェブサービスURLを入力します。サービスURLと利用するウェブの情報が異なる場合は認証に失敗する可能性があります。
• httpとhttpsは区分しません。
• www抜きで入力してください。(例: http://naver.com).
• サブドメインがある場合は代表のドメイン名のみ入力してください。(例: http://naver.com).
• ハイブリッドアプリはlocation.hrefオブジェクトの出力値を入力します。(例: file://ローカルURL).
• Androidアプリパッケージ名: Androidアプリケーションの場合のみ該当し、アプリのパッケージ名を正確に入力します。登録されたパッケージ名と利用するアプリのパッケージ名が異なる場合は認証に失敗する可能性があります。
• iOS Bundle ID: iOSアプリケーションの場合のみ該当し、登録されたBundle IDと利用するアプリの情報が異なる場合は認証に失敗する可能性があります。

Applicationリスト

アプリケーションが正常に登録されると、次のイメージのようにAI·NAVER API > AI·NAVER API > Applicationで登録したApplication名のリストが表示され、Applicationごとに次のような情報を確認できます。

① サービスタイプ: 選択したサービスを確認します。

② 当日/当月の使用量: Applicationごとに、サービス別のリアルタイムの使用量を%で確認できます。(UTC+9基準です。)

③ 限度およびアラーム設定: API呼び出しの際、利用限度と特定の値(%)を超えた場合のアラーム機能を直接コントロールできます。

Application使用のための認証情報

Application名の下の認証情報をクリックすると、認証キーおよび登録されたサービス環境情報を確認できます。

① Applicationの名前の下に [Authentication] をクリックします。

② 認証キーおよび登録されたサービス環境情報を確認することができます。

• Application Key

  • Application名: Applicationを区分する名前です。
  • Client ID (X-NCP-APIGW-API-KEY-ID): 認証のためのIDと同じ値で、ヘッダまたはクエリストリングに'X-NCP-APIGW-API-KEY-ID'と入力します。
  • Client Secret (X-NCP-APIGW-API-KEY): 認証のためのSecretKeyパスワードのような性格を持ち、ヘッダまたはクエリストリングに'X-NCP-APIGW-API-KEY'と入力します。
    • Client上に表示されないように注意する必要があり、セキュリティのための再発行が可能です。

• サービス環境

  • Web URL: Web SDKを使用するための必須入力の値
  • Androidパッケージ名: Android SDKを使用するための必須入力の値
  • iOS Bundle ID: iOS SDKを使用するための必須入力の値

Client IDとClient SecretはAPIをHTTPヘッダの値に含ませて転送すれば呼び出しが可能です。

利用量情報およびAPIステータスの確認

AI·NAVER APIの利用量は3つの方法で確認できます。

当日の利用量および当月の利用量

各Serviceには日別/月別の利用限度が制限的に設定されています。

AI·NAVER API > AI·NAVER API > Applicationで確認できます。

利用現況をリアルタイムで確認できます。すべてのAPIはUTC+9基準です。(韓国時間の場合、00:00 AMに日別の利用量が0と初期化されます。)

パーセントとパーセント別の色表示があり、限度に到達した場合は一目で確認できます。

利用限度設定

① Applicationリストの画面で変更したいApplicationの特定のサービスの [限度設定] をクリックします。

② 月別および日別の限度を入力します。

しきい値アラーム設定

利用限度が特定の値(%)を超えた場合、10%ごとにメールまたはショートメッセージでアラームを受信できる機能です。

① 限度設定のタブで日別の限度設定または月別の限度設定の右側にあるチェックボックスを選択します。

② アラームの基準になるしきい値(%)を選択します。

• (例: 70%を選択した場合、70%, 80%, 90%, 100%の時、アラーム)

③ メールまたはショートメッセージでの受信は下の通知対象設定で設定できます。

通知対象設定

しきい値アラーム設定に関し、受信者と受信方法を設定できます。通知対象者が設定されていない場合はアラームが送信されないことがあります。

① 通知対象設定タブをクリックします。

② 担当者の名前および通知方法をクリックした後、[追加] ボタンをクリックします。

• 新しいメールアドレスまたは携帯電話番号を追加したい場合、右側の上段にある通知対象管理をクリックしてください。
  • 通知対象設定管理の場合、MANAGEMENT > Monitoring > 詳細モニタリング使用ガイド > Step 7. 通知対象管理をご参考ください。

API統計グラフ

Serviceの性格によって呼び出しの数、文字数、時間などの単位が定められます。

AI·NAVER API > AI·NAVER API > Usage Statisticsで確認できます。

Applicationをまず選択した後、Serviceの統計を確認することができます。

API呼び出しの数を成功/失敗に区分して表示し、Service別の課金単位による利用量も同時に表示します。

利用の内訳

ポータル内のMy Page > 利用の内訳では前日基準の利用の内訳を確認できます。