NAVER連携 API

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

NAVER連携 APIのサポート情報を確認し、APIの共通呼び出しおよび認証方法を確認します。NAVER連携 APIとは、HTTPヘッダに Client IDと Client Secret値のみ送信することですぐ呼び出して使用できる Open APIであり、Maps、CLOVA、Papagoなどのサービスがあります。

サポートする API

NAVER連携 APIは Maps、CLOVA、Papagoなどのサービズにおいて、様々な機能を制御できます。サービス別にサポートする APIの具体的なリストはサービス別の APIガイドでご確認ください。

API呼び出し

NAVER連携 APIの呼び出し段階は次の通りです。

1. Applicationの登録
2. 認証情報の確認
3. サービスの選択

1. Applicationの登録

APIを呼び出す時、HTTPヘッダに Client IDと Client Secret値を含めて転送する必要があるため、まずは Applicationを登録します。NAVERクラウドプラットフォームのコンソールで Applicationを登録する方法は、次の通りです。

1. NAVERクラウドプラットフォームのコンソールで Services > AI·NAVER API > AI·NAVER API のメニューを順にクリックします。
2. [Application 登録] ボタンをクリックします。
3. AI·NAVER APIのサービス利用約款および NAVER APIサービス利用約款に同意してください。
4. AI·NAVER Serviceで使用する Application名を登録します。
   • 名称は最大40文字まで入力できますが、今後追加されるサービスの特性によっては、画面に出力される Application名として使われる可能性があるため、なるべく10文字以内のシンプルな名称を推奨
5. Applicationで使用するサービスをクリックして選択します。
   • NAVERクラウドプラットフォームを通じて連携できるサービスを選択
6. 選択した Applicationから利用するサービス環境情報を入力し、 [登録] ボタンをクリックします。
   • サービス URLは複数選択可能
   • Androidアプリのパッケージや iOS Bundle IDは それぞれ1つずつのみ登録可能
7. 登録を完了すると、 AI·NAVER API > Application に登録された Applicationリストを確認します。
   • サービス区分: 選択したサービス
   • 当日/当月の使用量: Applicationごとのサービス別にリアルタイム使用量を%で確認(UTC+0基準)
   • 限度設定: 利用限度を直接調節可能

2. 認証情報の確認

Application登録を完了した後、API呼び出しに必要な Client IDと Client Secret値を確認する方法は次のとおりです。

1. NAVERクラウドプラットフォームのコンソールで Services > AI·NAVER API > AI·NAVER API のメニューを順にクリックします。
2. Applicationリストから、登録された Applicationを確認した後、アプリ名の下にある [認証情報] のボタンをクリックします。
3. 認証情報のポップアップが表示されたら、Client IDと Client Secret値を確認してください。
   • 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」と入力
   • サービス環境
     • Web URL: Web SDKを使用するための必須入力値
     • Androidパッケージ名: Android SDKを使用するための必須入力値
     • iOS Bundle ID: iOS SDKを使用するための必須入力値

3. サービスの選択

サービスを選択する方法は次の通りです。

1. NAVERクラウドプラットフォームのコンソールで Services > AI·NAVER API > AI·NAVER API のメニューを順にクリックします。
2. [Application変更] のボタンをクリックします。
3. Applicationが選択されているかを確認し、選択されていない場合に選択します。

4. 呼び出し

1.~3.の手順に沿って、APIを呼び出します。API呼び出しによる結果は成功と失敗に分けられます。レスポンスに成功した場合、リターンされた結果を確認します。レスポンスに失敗した場合、エラーコードがリターンされます。リターンされたエラーコードを確認してから、呼び出しを再試行してください。

成功

サービス API呼び出しへのレスポンス処理方法は、各サービスの APIガイドでレスポンスに関する情報をご参照ください。

失敗

呼び出しに失敗してリターンされるエラーコードには、サービス共通のエラーコードとサービス別のエラーコードがあります。サービス別のエラーコードは、各サービスの APIガイドでエラーコードに関する情報をご参照ください。共通エラーコードの場合、JSON形式はデフォルト値(default)です。共通エラーコード別のメッセージと説明は次の通りです。

共通エラーコードの例は次の通りです。

{
 "error":{
    "errorCode":"210",
    "message":"Permission Denied"
 }
 }