Available in Classic and VPC
This guide provides information on the items to check and the integration information to modify when migrating APIs from the existing NAVER Developers Center to NAVER API HUB.
To use the same features as the existing API in NAVER API HUB, you must subscribe to the service using a NAVER Cloud Platform account, register a new application, and apply the issued authentication information and API call address to your service code.
Migration procedure
The procedure for migrating APIs used in the NAVER Developers Center to NAVER API HUB is as follows:
- Compare before and after migration and check existing integration information: Check the differences in usage between the existing NAVER Developers Center and NAVER API HUB, and check the API call address, HTTP method, request headers, and request parameters used in the existing service code.
- Subscribe to NAVER API HUB and register an application: Subscribe to NAVER API HUB on the NAVER Cloud Platform console, and register the application to be used for API calls.
- Check and modify authentication information: Check the Client ID and Client Secret issued on NAVER API HUB, and replace the existing authentication information with the new authentication information.
- Modify API call information and check operations: Modify the API call address and request headers based on NAVER API HUB, and verify that calls are operating normally.
- Check error handling: Check the error responses returned in failure scenarios such as authentication failure, unauthorized access, or missing required parameters, and verify that the exception handling logic of your existing service operates normally.
Before starting the migration, check the following items in your existing service code.
| Items to check | Description |
|---|---|
| API used | API being used in the existing service.
|
| Call address | Check the API endpoint being called in the service code. |
| HTTP Method | Check the API call method, such as GET or POST. |
| Request headers | Check the existing authentication headers and how authentication information is used. |
| Request parameters | Check the query string or request body items sent when calling the API. |
1. Compare before and after migration and check existing integration information
The following are the main interfaces you can check when migrating from the NAVER Developers Center to NAVER API HUB:
| Interface example | Existing NAVER Developers Center | NAVER API HUB |
|---|---|---|
| Subscribe to the service. | - |  |
| Select API and register application. |  |
 |
| Input application information. |  |
 |
| Check authentication information. |  |
 |
| Check API call results. |  |
 |
2. Subscribe to NAVER API HUB and register an application
To use NAVER API HUB, you need to subscribe to the service on the NAVER Cloud Platform console, and register the application to be used for API calls.
The procedure for subscribing to the service and registering an application is as follows:
- Access the NAVER Cloud Platform console.
- Navigate to Menu > Services > Application Services > NAVER API HUB > Subscribe.
- In the Subscription menu, click [Subscribe].
- Review the terms of service and personal information provision guidelines, and complete your subscription.
- In the Application menu, click [Register an application].
- Select the API you want to use, and click [Next].
- Enter the application name and complete the registration.
- In NAVER API HUB, you can register multiple APIs within a single application.
- However, because the call address and request parameters differ for each API, you must separate and implement the call logic for each API in your service code.
3. Check and modify authentication information
Once application registration is complete, the authentication information required for API calls is generated.
Because authentication information from the existing NAVER Developers Center cannot be used for NAVER API HUB calls, you must apply the newly issued Client ID and Client Secret from NAVER API HUB to your service code.
The following are items to check when modifying authentication information:
| Items to be modified | NAVER Developers Center | NAVER API HUB | Change |
|---|---|---|---|
| Client ID | Client ID of the existing application | Client ID of the NAVER API HUB application | Replace with the newly issued Client ID. |
| Client Secret | Client Secret of the existing application | Client Secret of the NAVER API HUB application | Replace with the newly issued Client Secret. |
| Client ID request headers | X-Naver-Client-Id |
X-NCP-APIGW-API-KEY-ID |
Change the request header name based on NAVER API HUB. |
| Client Secret request headers | X-Naver-Client-Secret |
X-NCP-APIGW-API-KEY |
Change the request header name based on NAVER API HUB. |
| Authentication information application location | Service code or environment variables | Service code or environment variables | Check where the existing authentication information is used, and update it with the new authentication information. |
The procedure for checking authentication information is as follows:
- In the NAVER API HUB menu, click Application.
- Select the registered application in the Application management interface.
- Click [Credentials].
- Check the Client ID and Client Secret.
- Apply verified values to your service code or environment variables.
The following image is an example of the interface for checking authentication information in NAVER API HUB.
- The Client ID and Client Secret used in the existing NAVER Developers Center cannot be used for NAVER API HUB calls.
4. Modify API call information and check operations
After checking the authentication information, change the API call address and request headers in your existing service code based on NAVER API HUB.
When modifying API call information, you must also check the call address, request headers, request parameters, and successful response formats.
Example of modifying call information
| Items to check | NAVER Developers Center | NAVER API HUB | Change |
|---|---|---|---|
| Call domain | https://openapi.naver.com |
https://naverapihub.apigw.ntruss.com |
Change to the NAVER API HUB call domain. |
| API Path | /v1/search/news.json |
/search/v1/news |
Change to the API path specified in the NAVER API HUB development guide. |
| HTTP Method | GET |
GET |
Check based on the development guide for each API. |
| Query String | query={QUERY}&display=5 |
query={QUERY}&display=5 |
Verify whether they can be used interchangeably based on the API development guide and actual call results. |
| Client ID header | X-Naver-Client-Id |
X-NCP-APIGW-API-KEY-ID |
Change to the NAVER API HUB authentication header name. |
| Client Secret header | X-Naver-Client-Secret |
X-NCP-APIGW-API-KEY |
Change to the NAVER API HUB authentication header name. |
The following are examples of calls before and after the modification:
# 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}"
- The example above is based on the News search API.
- Refer to the development guide for each API for its call address, HTTP method, and request parameters.
Check operations
After modifying the API call information, verify that a successful response is returned. Focus on checking the HTTP status code, response format, and major response fields used in your service code.
| Items to check | Modified or not | Description |
|---|---|---|
| HTTP status code | No change for successful calls. | Verify that 200 OK is returned during a normal call. |
| Response body structure | Requires verification for each API. | Verify that the major response fields used in your existing service code are returned identically. |
| Major response fields | Requires verification for each API. | Example: Check fields used in the service code, such as items, title, link, and description. |
| Response parsing logic | Requires verification for each API. | Verify whether the existing response parsing logic can be used without modification. |
| Response header | Subject to change. | Response headers related to API Gateway may be added or modified. Verification is required if response headers are used in your service code. |
- Because response structures may vary by API, verify them against the actual call results and the API development guide.
- In particular, if your service code performs conditional branching based on specific response fields or error codes, you must separately verify that it operates identically after migration.
5. Check error handling
To verify that the exception handling logic of your existing service operates normally after migration, examine the error responses returned in API call failure scenarios.
The following are error cases you can check:
| Error case | Description |
|---|---|
| Missing authentication header | Check the error response returned when calling without an authentication header. |
| Incorrect authentication information | Check the error response returned when an invalid Client ID or Client Secret is sent. |
| Incorrect call address | Check the error response returned when calling a non-existent API path. |
| Missing required parameter | Check the error response returned when a required request parameter is omitted. |
| Unsupported API call | Check the error response returned when an unprovided API is called. |
- Because NAVER API HUB is provided based on API Gateway, its error response format or status code may differ from the existing NAVER Developers Center.
- If your existing service implements branching logic based on error codes, separately check the error responses after migration.
Relevant guides
For detailed instructions on using NAVER API HUB, see: