NAVER linkage API

Available in Classic and VPC

This guide provides support information for the NAVER integration API and describes common API calls and authentication methods. The NAVER integration API is an open API that can be called and used by sending only the Client ID and Client Secret values in the HTTP header, which can be used with services such as Maps, CLOVA, and Papago.

Supported APIs

The NAVER integration API can control various functions of services such as Maps, CLOVA, and Papago. Refer to the API guide of each service for a specific list of supported APIs.

API Call

The steps for calling the NAVER integration API are as follows:

1. Register application
2. Check authentication information
3. Select service

1. Register application

Because the Client ID and Client Secret values must be included in the HTTP header when calling the API, the application must first be registered. An application can be registered via the NAVER Cloud Platform console as follows:

1. From the NAVER Cloud Platform console, go to Services > AI·NAVER API > AI·NAVER API.
2. Click [Register application].
3. Consent to the AI·NAVER API Service Terms and Conditions and NAVER API Terms of Service.
4. Register the application to be used in the AI·NAVER Service.
   • Although up to 40 characters are allowed, a concise name of 10 characters or fewer is recommended because the name may be used as the main application name displayed on screen according to certain service characteristics.
5. Click and select the service(s) you want to use in the application.
   • Select a service that can be integrated with NAVER Cloud Platform.
6. Enter the service environment information for the selected application, then click [Register].
   • Multiple service URLs can be selected.
   • Only one Android app package or iOS bundle ID can be registered.
7. When registration is complete, check the list of registered applications from AI·NAVER API > Application.
   • Service category: Selected service
   • Daily/monthly usage: Check real-time usage information for each application and service (based on UTC+0)
   • Limit settings: Directly adjust usage limits

2. Check authentication information

Check the Client ID and Client Secret values required for API calls as follows:

1. From the NAVER Cloud Platform console, go to Services > AI·NAVER API > AI·NAVER API.
2. Make sure that the application is registered in the list of applications, then click [Authentication information] below the app name.
3. When the Authentication information pop-up window appears, check the Client ID and Client Secret values.

   • Application Key

     • Application name: Application identifier
     • Client ID (X-NCP-APIGW-API-KEY-ID): ID for authentication. Enter as “X-NCP-APIGW-API-KEY-ID” in header or query string.
     • Client Secret (X-NCP-APIGW-API-KEY): SecretKey password for authentication. Enter as “X-NCP-APIGW-API-KEY” in header or query string.

   • Service Environment

     • Web URL: Required value for using the web SDK
     • Android package name: Required value for using Android SDK
     • iOS Bundle ID: Required value for using iOS SDK

3. Select service

A service for use with an application can be selected as follows:

1. From the NAVER Cloud Platform console, go to Services > AI·NAVER API > AI·NAVER API.
2. Click [Edit application].
3. Make sure that the application is selected.

4. Call API

The API can be called after successfully completing Steps 1 through 3, and a call can result in either a success or failure. A successful call returns results, while a failed call returns an error with the corresponding error code(s). For a failed call, you can check the returned error code(s) and try the call again.

Success

For information on how to handle responses to service API calls, refer to the response information in the API guide of each service.

Failure

Error codes returned from failed calls include common service error codes and service-specific error codes. For service-specific error codes, refer to the error codes in the API guide of each service. Common error codes are provided in JSON format by default. Messages and descriptions for each common error code are as follows:

The following is an example of a common error code:

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