API Template registration and management

Prev Next

Available in Classic and VPC

This menu allows you to register and manage APIs to configure Workflows. You can register or change APIs, perform call tests on any registered APIs, and delete unused APIs. You can test APIs during registration to immediately see the expected response results when calling the API.

Register API

You can register a new API by registering the API's name, method, URL, and request parameters. When registering a NAVER Cloud Platform API, select NCP Signature as the Authority to use the API without having to configure a separate signature.

To register an API Template:.

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Management & Governance > API Workflow.

  2. In the API Template menu, click [Register API Template].

  3. Enter the information for the API you want to register.

    Item Description
    Name
    URL
    Tag
    Authority
    Request
  4. After entering the parameters, headers, and body values in the Request area, click [Add].
    apiworflow-apitemplate_add_ko.png

    Item Description
    Parameters
    Headers
    Body
  5. To test the API, click [Test] in the URL field.

  6. When the Test Request popup appears, click [Test], then check the results and click [Close].

  7. Click [Save].

  8. Check the list of APIs.

Check registered API lists

API Template allows you to view a list of registered APIs. You can filter APIs by Method and search APIs by name, URL, and tag. Click a registered API to see more information about that API.
To check the list of registered APIs:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Management & Governance > API Workflow.
  2. Check registered APIs in the API Template menu.
    • You can search registered APIs by URL, name, or tag in the top right corner of the interface.
    • You can also search registered APIs according to Method.

Edit APIs

To edit information for an API that you have already registered:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Management & Governance > API Workflow.
  2. Click the API Template menu to see a list of registered APIs.
  3. Select the API you want to modify and click [Edit].
  4. When the edit popup appears, edit the information as necessary, then click [Test].
  5. Click [Save].

Delete APIs

You can also delete APIs that you no longer use. To delete a registered API:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Management & Governance > API Workflow.
  2. Click the API Template menu to see a list of registered APIs.
  3. Select the API you want to delete and click [Delete].
  4. When the delete window appears, click [Delete].