Documentation Index

Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

Application

Prev Next

Available in Classic and VPC

Note

Maps API service, which had been provided by NAVER Cloud Platform, has been upgraded and newly released. Use the new Maps service, which provides custom styling for NAVER Maps content.

Once you've reviewed the Maps specifications and quickstart, you're ready to start using the service. Your next step is subscribing to and managing Maps. You can subscribe and manage your subscription to Maps in the Application menu of the NAVER Cloud Platform console.

Note

Since Maps is an API-based service, you can only subscribe, unsubscribe, and manage subscriptions in the NAVER Cloud Platform console. For more information about the console UI interface, see Application user guide, a common document for AI·NAVER API.

Here are the topics covered in this guide:

Subscribe to Maps

There is no separate procedure for subscribing to Maps. You can create and manage an application directly from Menu > All Services > AI·NAVER API > AI·NAVER API > Application on the NAVER Cloud Platform console. To create an application, you must agree to the AI·NAVER API terms of service in the NAVER Cloud Platform console. The AI·NAVER API terms of service contain the rights and obligations of the user, usage restrictions and pricing information, and special terms and conditions, so you must check them before using Maps.

Note

You need to agree to the AI·NAVER API's terms of service when you use NAVER Cloud Platform's AI·NAVER API service for the first time. If you are already using other AI·NAVER API services, you can skip the process and go to Register application.

To agree to the AI·NAVER API's terms of service to use Maps:

  1. Access the NAVER Cloud Platform console.
  2. In the top-right corner, click Region & Platform.
  3. Select your region and platform, then click [Apply].
  4. In the top-left corner, click Menu.
  5. Navigate to All Services > AI·NAVER API > AI·NAVER API.
  6. Click the Application menu.
  7. Click [Register an application].
  8. When the AI·NAVER API terms of service screen appears, click Agree to the AI·NAVER API terms of service.
  9. Click [OK].
  10. View the list of applications that you can register and proceed to the following steps:
Note

You can go directly to step 6 by clicking [Subscribe] in Services > Application Services > Maps of the NAVER Cloud Platform portal.

Register an application

You must register the application after agreeing to the API terms of service. An application is required for the use of Maps API. Once you register an application, a unique client ID and a client secret value are created per application. You must apply the authentication key to the Maps API to receive authentication for using NAVER Maps.

Note

For more information on how to call APIs, see NAVER integrated API call in NAVER Cloud Platform's API guide.

Caution

The Web Dynamic Map API, Static Map API, Geocoding API, and Reverse Geocoding API from the Maps API provide free usage only to the primary account. Note that charges apply if you are using a non-primary account. This policy has been applied to the service since January 2023. To view whether the account currently logged into the console is a primary account, see View Maps primary account.

To register an application:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. Click [Register an application].
  4. Enter the application name.
    • You can enter up to 20 characters.
    • Depending on the service, the application name may be displayed on the interface, so enter a name of up to 10 characters.
  5. In the Service selection component, click and select Maps.
    • If the Maps checkbox is clicked, all Maps are selected.
    • After unchecking the Maps checkbox, individual Maps can be selected.
    • [Service description/Pricing information]: Navigate to the service introduction interface of the NAVER Cloud Platform portal.
    • [Development guide]: Go to the Maps user guide.
  6. In the Service environment registration component, enter the service environment of the application.
    • Web service URL
      • Up to 10 web service URLs that begin with http:// can be entered.
      • No difference between http and https. Enter excluding www. Example: http://naver.com
      • Enter the main domain only even if there are subdomains.
      • If information of the service URL differs from the web used, the authentication may fail.
      • For hybrid apps, enter location.href object outputs. Example: file://local URL
    • Android app package name
      • For Android applications only, up to 10 can be entered.
      • If the entered package name differs from the package name of the app in use, the authentication may fail.
    • iOS Bundle ID
      • For iOS applications only, up to 10 can be entered.
      • If the registered bundle ID differs from the information of the app in use, the authentication may fail.
    Note
    • When selecting Web Dynamic Map, a web service URL should be entered. If not entered, the application registration is not completed.
    • When selecting Mobile Dynamic Map, an Android app package name or iOS Bundle ID must be entered. If no package name or iOS Bundle ID is entered, certain restrictions may apply to SDK use.
    • When selecting Static Map, you must enter a web service URL. If no URL is entered, certain restrictions may apply to API use.
    • The client ID and secret value issued for 1 application may be applied to multiple environments including Android, iOS, web, and Windows App. However, the API usage is added up by each client ID.
  7. Click [Register].

View application information

You can view the list of registered applications by navigating to Menu > All Services > AI·NAVER API > AI·NAVER API > Application on the NAVER Cloud Platform console. To view application information from the application list:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. View application information.
    • App name: The name of the app set when registering the application.
    • Service type: The service selected when registering the application.
    • Daily/monthly usage: Real-time usage by service (based on UTC+9).
    • Set limits and notifications: API call usage limit and notification setting when a specific value (%) is exceeded.
    • Registration date: The date the application was registered.
  4. Click [Credentials].
    maps-application_screen1_ko
  5. When the credentials window appears, view the credentials.
    • Application Key
      • Application name: The name that identifies the application.
      • Client ID (X-NCP-APIGW-API-KEY-ID): Enter "X-NCP-APIGW-API-KEY-ID" in the header or query string as the ID required for authentication. You can copy the value by clicking clovasummary-ico_01.
      • Client Secret (X-NCP-APIGW-API-KEY): Enter "X-NCP-APIGW-API-KEY" in the header or query string as the SecretKey required for authentication. You can copy the value by clicking clovasummary-ico_01 and change the value by clicking [Reissue].
    • Service environment
      • Web service URL: The value required to use web SDKs.
      • Android app package name: The value required to use Android SDKs.
      • iOS Bundle ID: The value required to use iOS SDKs.
  6. Click [OK].
Caution

Make sure the Client ID and Client Secret are kept confidential. If you are concerned about security, reissue the credentials with a new value in step 7.

Edit an application

To edit the registered application information:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. Click [Edit] on the application you want to edit.
  4. Edit the necessary information and click [Save].

Manage Maps usage

You can view the usage status for each registered application and set various options for billing management.

View daily/monthly usage

To view daily and monthly usage:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. From the application list, view the real-time usage for the day and for the current month of the application for which you want to view the usage.
    • Based on UTC+9.
    • The daily usage is initialized to 0 at 12:00 AM (KST).
Note

It takes around 1 minute for the actual daily/monthly usage to be reflected.

Set usage limits

You can set daily and monthly usage limits yourself to prevent excessive service usage fees from being charged. To set usage limits:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. Click [Set limits and notifications] from the application list of the application that you want to edit the usage limit of.
    maps-application_screen2_ko
  4. Enter the monthly and daily limit values under the [Set limits] tab menu.
    maps-application_screen3_ko
  5. Click [Save].
Note

You can view the change history of usage limit under the [Limit change history] tab menu in the Set limits and notifications popup.

Set threshold notifications

When a certain usage rate of the daily/monthly limit value set by the user is exceeded, you can receive notifications through email or SMS.
To set up a threshold notification:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. Click [Set limits and notifications] from the application list of the application that you want to edit the usage limit of.
  4. Click the checkbox for the daily or monthly limit settings item under the [Set limits] tab menu.
  5. Select the threshold value (%) at which you want to be notified.
    maps-application_screen4_ko
    • If 70% is selected, notifications are sent at 70%, 80%, 90%, and 100%.
    • If 90% is selected, notifications are sent at 90% and 100%.
  6. Click [Save].
  7. To enter the address at which you want to receive the threshold notifications, see Set notification recipients.
Note

You will not receive notifications if you do not set notification recipients, even if you have set threshold notifications. Make sure to set notification recipients.

Set notification recipients

To set up notification recipients and notification methods for when usage exceeds a specified percentage of the daily/monthly limit you set:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. Click [Set limits and notifications] from the application list of the application that you want to edit the usage limit of.
  4. Click the [Set notification recipients] tab menu.
  5. Select a notification recipient and the notification method, and click [Add].
    • To go to Cloud Insight (Monitoring) to add a new person, click [Manage notification recipients].
  6. Once you complete setting up the notification recipients, click [Save].
Note

You can select only registered notification recipients in the notification recipient settings. You can register a new recipient in the Notification Recipient menu of Cloud Insight. For more information, see Add recipients in the Notification Recipient user guide.

Unsubscribe from Maps

There is no separate procedure for unsubscribing from Maps. If you delete the Maps application you created, you are unsubscribed from the service. To delete the application:

  1. Access the NAVER Cloud Platform console.
  2. In the top-right corner, click Region & Platform.
  3. Select your region and platform, then click [Apply].
  4. In the top-left corner, click Menu.
  5. Navigate to All Services > AI·NAVER API > AI·NAVER API.
  6. Click the Application menu.
  7. Click the application of Maps to be deleted, then click [Delete].
  8. When the Delete app popup appears, click [OK].

View Maps primary account

Due to the change in the Maps API pricing plan, the free usage for the Web Dynamic Map, Static Map API, Geocoding API, and Reverse Geocoding API is provided only to the primary account. To view the Maps API primary account:

  1. In the NAVER Cloud Platform console, navigate to Menu > All Services > AI·NAVER API > AI·NAVER API.
  2. Click the Application menu.
  3. When the Guide popup appears, click [View primary account].
    maps-application_FirstID1_ko
  4. In the View primary account popup, view the primary account information.
    maps-application_FirstID2_ko
    • If the account currently logged into the console is not the primary account, a relevant guide is displayed.
      maps-application_FirstID21_ko
Note

You can also access the popup in step 5 by clicking [View primary account] on the Application interface.
maps-application_FirstID11_ko