Using Applications
    • PDF

    Using Applications

    • PDF

    Article Summary

    Available in Classic and VPC

    Before use

    Q. What is Application Service?

    • This service allows you to easily develop various applications using AI Service and Application Service; AI Service refers to an artificial intelligence service which has been trained using big data from NAVER services such as CLOVA and Papago, and so on while Application Service refers to APIs which is the implementation of a technology applied in NAVER services.

    Q. How can I use Application Service?

    • You can get an authentication key when registering your application in the NAVER Cloud Platform Console. You can use the key to authenticate your application for API access, and the root of the request URL is “naveropenapi.apigw.ntruss.com.” For entire URLs for each service, refer to “How to Use API.”

    Register application

    To use AI NAVER service, you must first register your application. You will get a unique client ID and client secret for your application once your application is successfully registered. Include these values in the HTTP header when calling an API.

    How to register application

    Click AI·NAVER API > AI·NAVER API > Application on the Console and agree to Terms of Service to continue.

    ainaver_application_1_en

    ① Enter an application name on the screen that appears after accepting Terms of Service.

    • The ideal length of a name is no more than 10 characters even though it can be up to 40 characters as the name entered here can be your Application name displayed on the screen depending on the service type.

    Select a service you want.

    • If you can integrate with a service through NAVER Cloud Platform, it means that the service is open to anyone. Thus, you can use it once you send a HTTP header with a client ID and client secret included to a server.

    ③ Enter environment information.

    • Enter the environment of your application. You can add multiple URLs, but you must register only one ID per Android package and iOS bundle.

      You can use one client ID and client secret in multiple environments such as Android, iOS, Web, and WindowsApp. Note that a client ID is used to calculate the sum of API requests.

    More information about environment items

    • Service URL: Enter a web service URL starting with “http://.” You could fail to authenticate your application if information of your service URL is not the same as that you are using in a production environment.
    • The system does not distinguish between http and https.
    • Do not include "www" in the URL (example: http://naver.com).
    • Enter a name of the top-level domain without subdomain names (for example, http://naver.com).
    • For hybrid apps, enter the output of the location.href object (for example, file://local URI).
    • Android app package name: It is applicable to the Android application only. Enter the package name correctly. You could fail to authenticate your application if the registered package name is not the same as that you are using in a production environment.
    • iOS bundle ID: It is applicable to the iOS application only. You could fail to authenticate your application if the registered bundle ID is not the same as information of the app you are using in a production environment.

    List of applications

    After you successfully register applications, you can see the list of applications from AI·NAVER API > AI·NAVER API > Application as shown below. In the list, you can find the information as follows:

    ainaver_application_2_en

    Service Category: Check the service you select.

    Usage per day/month: Check your real-time API usage data (unit: %) by service for every application. (time zone: UTC+9).

    Limit and notification : Change quota limits and Set threshold notification for each service.

    Authentication information

    ainaver_application_3_en

    ① Click Authentication under the application name.

    ② You can view your authentication and service environment information you registered.

    • Application Key

      • Application name: Name to identify your application.
      • Client ID (X-NCP-APIGW-API-KEY-ID): ID for authentication. Enter “X-NCP-APIGW-API-KEY-ID” in the header or query string.
      • Client Secret (X-NCP-APIGW-API-KEY): SecretKey password for authentication. Enter “X-NCP-APIGW-API-KEY” in the header or query string.
        • Care must be taken not to expose the value, which can be reissued for security purposes.
    • Service environment

      • Web URL: Required to use the Web SDK.
      • Android package name: Required to use the Android SDK.
      • iOS Bundle ID: Required to use the iOS SDK.

    Include a client ID and client secret in the HTTP header when calling an API.

    Check API usage and status

    There are three ways you can check your quota usage of AI·NAVER API.

    Daily and monthly usage

    Each service has daily and monthly limits.

    Go to AI·NAVER API > AI·NAVER API > Application to view your real-time usage status.

    All APIs are shown based on UTC+9. (In Korean Standard Time, daily usage is reset to 0 at 00:00 AM.)

    Percentages and colors make you easily track your usage progress.

    Quota limits

    ainaver_application_4_en

    ① Find an application and a service you want to set a quota limit for and click [Limit setting] in the same row.

    ② Enter monthly and daily limits.

    Set threshold notification

    This function allows users to receive notification by email or SMS every 10% if the limit of use exceeds a certain value (%).

    ainaver_application_6_en

    ① Select the check box on the right side of the daily limit setting or the monthly limit setting.

    ② Select the threshold value (%) for which you want to be notified.

    • (eg. if 70% is selected, notify 70%, 80%, 90%, and 100%)

    ③ You can set up e-mail or SMS reception via Notification Setting below.

    Notification Setting

    You can set up the recipient and the receiving method for setting the threshold notification. If no notification target is set, you might not be notified.

    ainaver_application_7_en

    ① Click on the Notification Setting tab.

    ② Select on the name of the notification manager and the method of notification, then click on the [Add] button.

    API statistical graph

    A service you select determines the type of a unit (requests, characters, or time) for quota limits.

    Go to AI·NAVER API > AI·NAVER API > Usage Statistics to view your statistical graph.

    Select an application first to view statistical information for the service.

    You can view not only the number of successes and failures but also quota limits based on pricing plans for each service.

    ainaver_application_5_en

    Usage history

    Log in to the NAVER Cloud Platform website and click My Page > Service Usage History to view API usage by yesterday.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    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.