Published APIs

Available in Classic and VPC

Share an API document of a product, or subscribe to an API document shared by another user.

Published APIs screen and list

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

Field	Description
① Menu name	Name of the menu currently being checked, number of products available for subscription
② Basic features	Check API Gateway details, refresh page
③ Catalog	Check and subscribe API documents shared by the user and other users
④ Search window	Enter the product name, and then click to search
⑤ Filter	API provision location (default: NCP), filter items based on subscription status change filter to view API lists other than APIs provided by NAVER Cloud Platform Select My to search APIs posted by the user
⑥ Sort	Set the number of API to display on list page
⑦ List	List of APIs shared by the user and other users Product Name: name of posted product Description: description of posted product Subscription Type: Subscription type of posted product (Public, Protected) Subscription: User subscription status of posted product

View catalog

Check the overview of API created in the product, and then check the stage document through the Swagger UI.
In case of API posted by the user, overview information can be edited.

The following describes how to check the overview and document of posted API.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click the Published APIs menu.
3. Click to select the product to check from the Posted Product list, and then click the [Catalog] button.
   • To view API list of APIs other than NAVER Cloud Platform provided ones, change the Product item of the filter.
4. Click the API name to check from the Product Catalog list.
5. Check the overview and document of the API from the View Details screen.
   • In case of APIs created by the user, the [Edit] button, which allows editing of overview, will be displayed. To edit, click the [Edit] button, enter information, and then click the [Save] button. Refer to Create API Manual Overview for more information about how to create an overview.
   • Click the Stage Name or to check the stage document through the Swagger UI.

Subscribe to Catalog

There are Public and Protected type subscription to a posted product.

• Public: Anyone can call the product API without an approval procedure, and the [Subscribe] button is not displayed on the Catalog screen.
• Protected: Approval by the user who posted the product API is required, and the [Subscribe] button is displayed on the Catalog screen.

If the subscription type of the posted product is Protected, Create API Key must be executed, and an API key approval procedure must be executed.

The following describes how to subscribe to a catalog.

1. From the NAVER Cloud Platform console, click the Services > Application Services > API Gateway menus, in that order.
2. Click the Published APIs menu.
3. Select a product with subscription type of Protected from the Published APIs menu, and then click the [Catalog] button.
4. Click the [Subscribe] button from the Product Catalog list.
5. Select the API key to receive authentication for the API to subscribe, and then click the [Request Subscription] button.
6. From the Subscription pop-up window, click the [Request Subscription] button.
   • Once subscription is complete, the value in the Subscription row of the product changes from Not subscribed to Requested.
   • Subscription status can also be checked from the Connected Stage List of the API Keys menu.
   • Refer to Change API Key Status for more information about API subscription status.
   • Refer to Disconnect Stage (Cancel Subscription) of API Keys menu to cancel API subscription.