NAVER API HUB の移行ガイド

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

本ガイドは、既存の NAVER Developers Centerで提供していた APIを NAVER API HUBに移行して使用する時に確認すべき項目や変更すべき連携情報をご案内します。

既存の APIと同じ機能を NAVER API HUBで使用するには、NAVERクラウドプラットフォームアカウントでサービスのご利用を申し込み、新しい Applicationを登録した後、発行された認証情報と API呼び出しアドレスをサービスコードに反映させる必要があります。

移行手順

NAVER Developers Centerで使用していた APIを NAVER API HUBに移行する手順は、次の通りです。

移行前後の比較と既存の連携情報の確認: 既存の NAVER Developers Centerと NAVER API HUBの利用方法の違いを確認し、既存のサービスコードで使用中の API呼び出しアドレス、HTTP Method、リクエストヘッダ、リクエストパラメータを確認します。
NAVER API HUBご利用の申し込みと Application登録: NAVERクラウドプラットフォームコンソールで NAVER API HUBのご利用を申し込み、API呼び出しに使用する Applicationを登録します。
認証情報の確認と変更: NAVER API HUBで発行された Client IDと Client Secretを確認し、既存の認証情報を新しい認証情報に置き換えます。
API呼び出し情報の変更と動作の確認: APIの呼び出しアドレスやリクエストヘッダを NAVER API HUBを基準に変更した後、正常な呼び出しの有無を確認します。
エラー処理の確認: 認証失敗、権限なし、必須パラメータの欠落など、失敗時に返されるエラーレスポンスを確認し、既存サービスの例外処理ロジックが正常に動作しているかを確認します。

移行を開始する前に、既存のサービスコードで次の項目を確認します。

確認項目	説明
使用 API	既存のサービスで使用中の API 例) 検索 API、データラボ APIなど
呼び出しアドレス	サービスコードで呼び出し中の APIエンドポイントを確認します。
HTTP Method	GETまたは POSTなどの API呼び出し方式を確認します。
リクエストヘッダ	既存の認証ヘッダと認証情報の使用方式を確認します。
リクエストパラメータ	API呼び出し時に転送する Query Stringまたは Request Body項目を確認します。

1.移行前後の比較と既存の連携情報の確認

NAVER Developers Centerから NAVER API HUBへの移行時に確認できる主な画面は、次の通りです。

画面例	既存の NAVER Developers Center	NAVER API HUB
サービスご利用の申し込み	-
API選択と Application登録
Application情報の入力
認証情報の確認
API呼び出し結果の確認

2.NAVER API HUBご利用の申し込みと Application登録

NAVER API HUBを使用するには、NAVERクラウドプラットフォームコンソールでサービスのご利用を申し込み、API呼び出しに使用する Applicationを登録します。

ご利用の申し込みと Applicationの登録手順は、次の通りです。

NAVERクラウドプラットフォームコンソールにアクセスします。
Menu > Services > Application Services > NAVER API HUB > 申し込むメニューを順にクリックします。
Subscriptionメニューで [サービスご利用の申し込み] ボタンをクリックします。
サービス利用規約と個人情報の提供に関するご案内を確認の上、ご利用の申し込みを完了します。
Applicationメニューで [Application登録] ボタンをクリックします。
使用する APIを選択し、 [次へ] ボタンをクリックします。
Application名を入力した後、登録を完了します。

参考

NAVER API HUBでは1つの Applicationに複数の APIを登録できます。
ただし、API別呼び出しアドレスとリクエストパラメータは異なるため、サービスコードでは API別呼び出しロジックを分離して実装する必要があります。

3.認証情報の確認と変更

Application登録を完了すると、API呼び出しに必要な認証情報が作成されます。

既存の NAVER Developers Centerで使用していた認証情報は NAVER API HUBの呼び出しに使用できないため、NAVER API HUBで新しく発行された Client IDと Client Secretをサービスコードに反映させる必要があります。

認証情報の変更時に確認すべき項目は、次の通りです。

変更項目	NAVER Developers Center	NAVER API HUB	変更内容
Client ID	既存の Applicationの Client ID	NAVER API HUB Applicationの Client ID	新しく発行された Client IDに置き換え
Client Secret	既存の Applicationの Client Secret	NAVER API HUB Applicationの Client Secret	新しく発行された Client Secretに置き換え
Client IDリクエストヘッダ	`X-Naver-Client-Id`	`X-NCP-APIGW-API-KEY-ID`	リクエストヘッダ名を NAVER API HUB基準に変更
Client Secretリクエストヘッダ	`X-Naver-Client-Secret`	`X-NCP-APIGW-API-KEY`	リクエストヘッダ名を NAVER API HUB基準に変更
認証情報の適用位置	サービスコードまたは環境変数	サービスコードまたは環境変数	既存の認証情報の使用位置を確認した後、新規認証情報に変更

認証情報の確認手順は、次の通りです。

NAVER API HUBメニューで Applicationをクリックします。
Application Management画面で登録した Applicationを選択します。
[認証情報] ボタンをクリックします。
Client IDと Client Secretを確認します。
確認した値をサービスコードまたは環境変数に反映させます。

次の画像は、NAVER API HUBで認証情報を確認する画面の例です。

NAVER API HUB認証情報画面

注意

既存の NAVER Developers Centerで使用していた Client IDと Client Secretは、NAVER API HUBの呼び出しに使用できません。

4.API呼び出し情報の変更と動作の確認

認証情報を確認した後、既存のサービスコードの API呼び出しアドレスとリクエストヘッダを NAVER API HUB基準に変更します。

API呼び出し情報の変更時には、呼び出しアドレス、リクエストヘッダ、リクエストパラメータ、正常なレスポンス形式を共に確認する必要があります。

呼び出し情報の変更例

確認項目	NAVER Developers Center	NAVER API HUB	変更内容
呼び出しドメイン	`https://openapi.naver.com`	`https://naverapihub.apigw.ntruss.com`	NAVER API HUB呼び出しドメインに変更します。
API Path	`/v1/search/news.json`	`/search/v1/news`	NAVER API HUB開発ガイドに明示された API Pathに変更します。
HTTP Method	`GET`	`GET`	API別の開発ガイドを基準に確認します。
Query String	`query={QUERY}&display=5`	`query={QUERY}&display=5`	API開発ガイドと実際の呼び出し結果を基準に同じように使用できるかを確認します。
Client IDヘッダ	`X-Naver-Client-Id`	`X-NCP-APIGW-API-KEY-ID`	NAVER API HUB認証ヘッダ名に変更します。
Client Secretヘッダ	`X-Naver-Client-Secret`	`X-NCP-APIGW-API-KEY`	NAVER API HUB認証ヘッダ名に変更します。

変更前後の呼び出し例は、次の通りです。

# NAVER Developers Center
curl -X GET "https://openapi.naver.com/v1/search/news.json?query={QUERY}&display=5" \
  -H "X-Naver-Client-Id: {DEVELOPERS_CLIENT_ID}" \
  -H "X-Naver-Client-Secret: {DEVELOPERS_CLIENT_SECRET}"

# NAVER API HUB
curl -X GET "https://naverapihub.apigw.ntruss.com/search/v1/news?query={QUERY}&display=5" \
  -H "X-NCP-APIGW-API-KEY-ID: {API_HUB_CLIENT_ID}" \
  -H "X-NCP-APIGW-API-KEY: {API_HUB_CLIENT_SECRET}"

参考

上記の例は、ニュース検索 API基準です。
API別の呼び出しアドレス、HTTP Method、リクエストパラメータについては、各 APIの開発ガイドをご参照ください。

動作確認

API呼び出し情報を変更した後、正常なレスポンスが返されるかを確認します。HTTPステータスコード、レスポンス形式、サービスコードで使用する主なレスポンスフィールドを中心に確認します。

確認項目	変更有無	確認内容
HTTPステータスコード	正常な呼び出し基準に変更なし	正常な呼び出し時に`200 OK`が返されるかを確認します。
レスポンス Body構造	API別に確認が必要	既存のサービスコードで使用していた主なレスポンスフィールドが同じように返されているかを確認します。
主なレスポンスフィールド	API別に確認が必要	例: `items`、`title`、`link`、`description`などのサービスコードで使用するフィールドを確認します。
レスポンスパースロジック	API別に確認が必要	既存のレスポンスパースロジックをそのまま使用できるかを確認します。
レスポンス Header	変更可能	API Gateway関連レスポンスヘッダが追加または変更されることがあります。サービスコードでレスポンスヘッダを使用する場合は確認が必要です。

参考

レスポンス構造は APIごとに異なることがありますので、実際の呼び出し結果や API開発ガイドを基準にご確認ください。
特に、サービスコードで特定のレスポンスフィールドやエラーコードを基準に分岐処理している場合は、移行後に同じように動作するかを別途確認する必要があります。

5.エラー処理の確認

移行後、既存のサービスの例外処理ロジックが正常に動作しているかを確認するには、API呼び出しが失敗した状況で返されるエラーレスポンスをご確認ください。

確認できるエラーケースは、次の通りです。

エラーケース	確認内容
認証ヘッダ欠落	認証ヘッダなしに呼び出した時に返されるエラーレスポンスを確認します。
間違った認証情報	無効な Client IDまたは Client Secretを転送した時に返されるエラーレスポンスを確認します。
間違った呼び出しアドレス	存在しない API Pathに呼び出した時に返されるエラーレスポンスを確認します。
必須パラメータの欠落	必須リクエストパラメータが欠落した時に返されるエラーレスポンスを確認します。
サポートしない APIの呼び出し	提供されない APIを呼び出した時に返されるエラーレスポンスを確認します。

注意

NAVER API HUBは API Gatewayを基盤に提供されるため、既存の NAVER Developers Centerとはエラーレスポンス形式またはステータスコードが異なる場合があります。
既存のサービスでエラーコード基盤の分岐処理を行っている場合は、移行後にエラーレスポンスを別途ご確認ください。

Documentation Index