Login
      Contents x
      AI NAVER API overview
        • Print
        • PDF
        Contents

        AI NAVER API overview

          • Print
          • PDF
          Article summary

          Available in Classic and VPC

          AI·NAVER API services provide various NAVER Cloud Platform's artificial intelligence services as an API format to help easily build and normally operate.
          To use AI NAVER API services, you must register and manage application information.

          Check the following details and use the services according to the procedures:

          Subscribe

          If you use NAVER Cloud Platform's AI NAVER API services for the first time, you must agree to the AI NAVER API service terms of service on NAVER Cloud Platform console. The AI·NAVER API service terms of service contain the rights and obligations of the user, usage restrictions and usage fees, and special terms and conditions, so you must check them before using the service.

          Note

          If you are already using other AI·NAVER API services, you can skip the process of agreeing to the terms of service and go to Register application.

          To agree to the AI·NAVER API service terms of service, follow these steps:

          1. Access NAVER Cloud Platform console.
          2. From the Region menu, click and select the Region in use.
          3. From the Platform menu, click and select between VPC and Classic.
          4. Click Services > AI·NAVER API > AI·NAVER API in order.
          5. Click the Application menu.
          6. Click the [Register application] button.
          7. When the AI·NAVER API terms of service screen appears, click Agree to the AI·NAVER API terms of service.
          8. Click the [OK] button.
          9. Check the list of applications that you can register and proceed to the following steps:
          Note

          Once you register an application, a unique client ID and a client secret value are created per 1 application. When you call APIs, the client ID and client secret value are transferred as included in the HTTP header value. For more information on how to call APIs, see Call NAVER integrated APIs in NAVER Cloud Platform API guide.

          Register application

          To register an application, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.

          2. From the Platform menu, click and select between VPC and Classic.

          3. Click Services > AI·NAVER API > AI·NAVER API in order.

          4. Click the Application menu.

          5. Click the [Register application] button.

          6. Enter the application name.

            • Up to 20 characters can be entered.
            • Depending on the service, the application name may be displayed on the screen, so use a name up to 10 characters.

          7. From the Service selection area, click and select the service you want to use.

            • [Service description/pricing information] button: click and go to the service introduction screen of NAVER Cloud Platform portal.
            • [Development guide] button: click and go to the service's user guide.

          8. From the Service environment registration area, 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 using app, 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 used, the authentication may fail.
            Note
            • 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.
            • You can add multiple web service URLs, but only register 1 Android app package or iOS bundle ID.

          9. Click the [Register] button.

          Check application information

          You can check the list of registered applications in AI·NAVER API > AI·NAVER API > Application on NAVER Cloud Platform console. To check application information from the application list, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Application menu.
          5. Check application information.
            • App name: the name of the app set when registering the application
            • Service type: selected service when registering the application
            • Daily/monthly usage: real-time usage by service (based on UTC+9)
            • Limit and notification settings: API call usage limits and notification settings when a specific value (%) is exceeded
              • Registration date: the date the application was registered
          6. Click the [Authentication information] button.
            ainaverapi_01_ko
          7. When the authentication information window appears, check the authentication information.
            • Application Key
              • Application name: the name to identify 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. Can copy value by clicking ainaverapi_05_ko
              • 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. Can copy value by clicking ainaverapi_05_ko, and change the value by clicking the [Reissue] button.
            • Service environment
              • Web service URL: value required to use Web SDK
              • Android app package name: value required to use Android SDK
              • iOS bundle ID: value required to use iOS SDK
          8. Click the [OK] button.
          Caution

          Make sure the client ID and client secret are kept confidential. If you are concerned about security, reissue the authentication information with new values in 7.

          Edit application

          To edit the registered application information, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Application menu.
          5. Click the [Edit] button of the application you want to edit.
          6. Edit the necessary information, and then click the [Save] button.

          Manage usage

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

          Check daily/monthly usage

          To check the usage for the day and for the current month, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Application menu.
          5. From the application list, check the real-time usage for the day and for the current month of the application for which you want to check the usage.
            • Based on UTC+9
            • The daily usage is initialized to 0 at 00:00 AM (KST).
          Note

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

          Set usage limits

          You can set up daily and monthly usage limits yourself to prevent excessive service usage fees from being charged. To set up a usage limit, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Application menu.
          5. Click the [Set limits and notifications] button from the application list of the application you want to edit the usage limit.
            ainaverapi_02_ko
          6. Enter the monthly and daily limit values under the [Set limits] tab menu.
            ainaverapi_03_ko
          7. Click the [Save] button.
          Note

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

          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, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Application menu.
          5. Click the [Set limits and notifications] button from the application list of the application you want to edit the usage limit.
          6. Click the checkbox for the daily or monthly limit settings item under the [Set limits] tab menu.
          7. Select the threshold value (%) at which you want to be notified.
            ainaverapi_04_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%.
          8. Click the [Save] button.
          9. See Set notification recipients to enter the address at which you want to receive the threshold notifications.
          Note

          You won't receive notifications if you don't have notification recipients set up, even if you've set up threshold notifications. Make sure to set notification recipients.

          Set notification recipients

          To set up notification recipients and notification methods for when a certain usage rate of the daily/monthly limit value set by the user is exceeded, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Application menu.
          5. Click the [Set limits and notifications] button from the application list of the application you want to edit the usage limit.
          6. Click the [Set notification recipients] tab menu.
          7. Select a person to receive notifications and the notification method, and then click the [Add] button.
            • To go to Cloud Insight (Monitoring) to add a new person, click the [Manage notification recipients] button.
          8. Once you complete setting up the notification recipients, click the [Save] button.
          Note

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

          Check API call volume

          To check the API call volume in a graph, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI·NAVER API > AI·NAVER API in order.
          4. Click the Usage statistics menu.
          5. Select the application name and service to view the API call volume, set a search period, and then click the [View] button.
          6. Check the graph.
            • View the number of API calls as a succeeded/failed graph.
            • View the amount of usage according to the billing unit for each service.
          7. Click the [Download] button to download the search results as an Excel file.

          Unsubscribe

          There is no separate procedure to unsubscribe to the service provided as APIs. If you delete the application of the service you created, your application is successfully unsubscribed. To delete the application, follow these steps:

          1. From the Region menu on NAVER Cloud Platform console, click and select the Region in use.
          2. From the Platform menu, click and select between VPC and Classic.
          3. Click Services > AI Services > AI·NAVER API in order.
          4. Click the Application menu.
          5. Click the application of the service you want to delete, and click the [Delete] button.
          6. When the Delete app popup window appears, click the [OK] button.
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout