Published APIs

Available in Classic and VPC

You can share a Product’s API documentation or subscribe to API documentation shared by other users.

Published APIs interface and list

The following provides a basic overview of the Published APIs menu for using API Gateway:

Component	Description
① Menu name	Current menu name. Number of subscribable Products.
② Basic features	View API Gateway details and refresh the page.
③ Catalog	View and subscribe to API documentation shared by you and other users.
④ Search bar	Enter the Product name and click to search for items.
⑤ Filter	Filter items by API provider location (default: NCP), and subscription status. Change the filter to view APIs other than those provided by the NAVER Cloud Platform. Select My to search for APIs published by the user.
⑥ Sort	Set the number of APIs displayed per list page.
⑦ List	List of APIs shared by you and other users. Product name: The name of the published Product. Description: The description of the published Product. Subscription type: The subscription type of the published Product (Public, Protected). Subscription: Indicate whether you are subscribed to the published Product.

View Catalog

You can view the Overview of APIs created in a Product and view stage documents through Swagger UI.
For APIs published by the user, you can edit the Overview content.

To view the Overview and Document of a published API:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the Published APIs menu.
3. In the published Product list, select the Product you want to review, then click [Catalog].
   • To view APIs other than those provided by the NAVER Cloud Platform, change the Product filter.
4. In the Product Catalog list, click the name of the API you want to review.
5. On the details interface, review the API Overview and the Stage Document.
   • For APIs created by the user, [Edit] appears, allowing you to modify the Overview. To edit the Overview, click [Edit], update the content, then click [Save]. For details on writing an Overview, see Write an Overview in API documentation.
   • To view the Stage Document through Swagger UI, click the stage name or .

Catalog subscription request

Published Products support two subscription types: Public and Protected.

• Public: Anyone can call the Product APIs without an approval process, and [Subscribe] is not displayed on the Catalog list interface.
• Protected: Approval from the publisher is required to use the Product APIs, and [Subscribe] is displayed on the Catalog list interface.

If the subscription type of a published Product is protected, you must Create an API Key and complete the API key approval process to subscribe.

To request a Catalog subscription:

1. In the NAVER Cloud Platform console, navigate to > Services > Application Services > API Gateway.
2. Click the Published APIs menu.
3. In the Published APIs menu, select a Product with a protected subscription type, then click [Catalog].
4. In the Product Catalog list, click [Subscribe].
5. Select the API key to be authorized for the API you want to subscribe to, then click [Request subscription].
6. In the Subscribe popup, click [Request subscription].
   • After the subscription request is completed, the value in the subscription column for the Product changes from unsubscribed to Requested.
   • You can also check the subscription status in the Connected stage list in the API Keys menu.
   • For details on API subscription status, see Change API Key status.
   • To cancel an API subscription, see Disconnect stage (unsubscribe) in the API Keys menu.