API Keys
  • PDF

API Keys

  • PDF

Available in Classic and VPC

API key is the value used to grant authorities to users, such as app developers, to access and use APIs registered in the API Gateway.
API key can create and manage API keys, and can connect with Stage.

API keys screen and list

The basics of using API keys menus on API Gateway are as follows.

apigw-apigw-2-5_list_ko

Field Description
① Menu name Name of the menu currently being viewed, number of API keys in operation
② Basic features Create API Key, view detailed API Gateway information, page refresh
Edit Edit API Key in use
Delete Delete API Key in use
View connected Stage Refer to Connect API Key to Stage and Management to view the Stage connected to the API key, view usage amount, cancel subscription
  • and see how to connect API key with Stage
⑥ Search window Enter the name of API key and click i-apigateway-find to search items
⑦ Sort Set the number of API keys to display on list page
⑧ API Keys List Check the list of API keys in use
  • API Key ID: ID of the created API key (automatic designation)
  • API Key Name: name of API key set during API key creation
  • Description: description of API key entered during API key creation
  • Status: Enable/disable state of current API key. Enabled automatically upon Create API Key, and enable status can be set. (Refer to Edit API Key)
  • API keys: Click the [View] button to Check, recreate, and copy API Key

Create API Key

To use an API registered on API Gateway, an API key must be created first.

The following describes how to create an API key.

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click the [Create API Key] button.
  4. After entering Create API Key information, click the [Save] button.
    • Name: Enter the name of API key
    • Description: Enter the description of API key
  5. Check whether the created API key is displayed on the API Keys list.

Check, recreate, and copy API keys

The following shows how to check, recreate and copy created API keys.

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click the [View] button of the API key on the API Keys list.
  4. Check, recreate, and copy the API key as necessary from the View API Key pop-up window.
    • Primary Key/Secondary Key: values to enter in the header when calling an API
    • To recreate an API key, click i-apigateway-newkey, check the information on the recreate confirmation pop-up window, and then click the [Yes] button.
    • To copy the API key to the clipboard, click i-apigateway-clipboard.
  5. Click the [OK] button.

Edit API Key

Name, description, and enable status of the API key can be edited.
The following describes how to edit the API key.

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click to select the API key to edit on API Keys list, and then click the [Edit] button.
  4. Edit information from the Edit API Key screen, and then click the [Save] button.
    • ID: Displays automatically created API Key ID.
    • Name: Edit the name of the API key entered during creation.
    • Description: Add or edit the description for the API key entered during creation.
    • Enable: Select API key enable status. If API key is not used, set to disable.
  5. Check whether the edited API key is displayed on the API Keys list.

Delete API Key

The following describes how to delete an API key.

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click to select the API key to delete from the API Keys list, and then click the [Delete] button.
  4. Check the details in the Delete pop-up window, and then click the [Delete] button.

Check and manage connected stages

Check stages connected to API keys from the list, check API usage amount or remove (cancel subscription).

Note

To check connected stages, API Keys must be connected to stage first.
Refer to Connect API Key to Stage and Management for how to connect the API key to stage.

Check connected Stage

The following describes how to check API keys connected to stage.

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click to select the API key to check connected stage from the API Keys list, and then click the [View Connected Stage] button.
  4. Check on the API key status from the Connect Stage pop-up window.
    • Product Name: Displays product names with stage connected.
    • Description: Displays the description entered when creating the product.
    • Status: Displays the current API key status.
    • Request Date: date when API key and stage connection is requested
    • Edit Date: date when API key status was edited
    • To Check API Usage Amount, click a product name to check and click the [View Usage Amount] button.
    • To Disconnect Stage (Cancel Subscription), click a product name to disconnect, and then click the [Cancel Subscription] button.

Check API usage amount

The following describes how to check the API usage amount of the stage connected to API key.

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click to select the API keys from the API keys list, and then click the [View Connected Stage] button.
  4. Click the product name to check API usage, and then click the [View Usage Amount] button.
  5. Check the information from view usage amount screen.
    • Product Name: Displays the product name of the stage connected to API key.
    • API Name: name of the API of stage connected to API key
    • Stage Name: name of the stage connected to API key
    • Daily Call/Request Processing Limit: Displays the number of daily calls and the daily request processing limit set in the usage plan.
    • Monthly Call/Request Processing Limit: Displays the number of monthly calls and the monthly request processing limit set in the usage plan.

Disconnect stage (cancel subscription)

The following describes how to disconnect the stage connected to API keys (cancel subscription).

  1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
  2. Click the API Keys menu.
  3. Click to select the API keys from the API keys list, and then click the [View Connected Stage] button.
  4. Click to select the stage to disconnect from the Connected Stage list screen, and then click the [Cancel Subscription] button.
  5. Check the details in the Cancel Subscription pop-up window, and then click the [Yes] button.
  6. Check whether the stage is deleted from the Connected Stage list.
    • If the stage connection is disconnected with the product API key set to Approved, the related API key items will also be removed from the API Keys list.
    • If the stage connection is disconnected with product API key set to Refuse, related items will not be deleted from the API Keys list connected to the product and is displayed to Request Refused.

Was this article helpful?

What's Next