API Templateの登録と管理

Prev Next

Classic/VPC環境で利用できます。

Workflowを構成するための APIを登録して管理するメニューです。新しい APIを登録したり、変更することができます。また、登録された APIの呼び出しテストを実行したり、使用しない APIは削除することもできます。APIを登録する段階でテストを行えるので、API呼び出し時に予測されるレスポンス結果をすぐさま確認できます。

API登録

APIの名前、Method、URL、リクエストパラメータを登録して新しい APIを登録できます。NAVERクラウドプラットフォームが提供する APIを登録する際に Authorityで NCP Signatureを選択すると、別途 Signature設定手続きなしで NAVERクラウドプラットフォームの APIを使用できます。

API Templateを登録する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Management & Governance > API Workflowメニューを順にクリックします。

  2. API Templateメニューで [API Template登録] ボタンをクリックします。

  3. 登録する API情報を入力します。

    項目 説明
    名前
    URL
    Tag
    Authority
    Request

  4. Requestに Parameters、Headers、Body値を入力し、 [追加] ボタンをクリックします。
    apiworflow-apitemplate_add_ko.png

    項目 説明
    Parameters
    Headers
    Body

  5. APIをテストするには、URLフィールドの [Test] ボタンをクリックします。

  6. Test Request画面が表示されたら、 [Test] ボタンをクリックして結果を確認し、 [閉じる] ボタンをクリックします。

  7. [保存] ボタンをクリックします。

  8. APIリストを確認します。

登録された APIリストを確認

登録された APIを確認できます。Methodに応じてフィルタ機能を提供し、名前、URL、Tagを基準に検索できます。 登録された APIをクリックすると、その APIに関する詳細情報を確認できます。
登録された APIを確認する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Management & Governance > API Workflowメニューを順にクリックします。
  2. API Templateメニューで登録された APIを確認します。
    • 画面右上で URL、名前、Tagを基準に検索できます。
    • 登録された APIの Methodを基準に検索できます。

API変更

登録した APIの情報を変更する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Management & Governance > API Workflowメニューを順にクリックします。
  2. API Templateメニューをクリックして登録された APIリストを確認します。
  3. 変更する APIを選択し、 [変更] ボタンをクリックします。
  4. 変更画面が表示されたら、情報を変更して [Test] ボタンをクリックします。
  5. [保存] ボタンをクリックします。

API削除

使用しなくなった APIは削除できます。 登録された APIを削除する方法は、次の通りです。

  1. NAVERクラウドプラットフォームコンソールで、i_menu > Services > Management & Governance > API Workflowメニューを順にクリックします。
  2. API Templateメニューをクリックして登録された APIリストを確認します。
  3. 削除する APIを選択し、 [削除] ボタンをクリックします。
  4. 削除画面が表示されたら、 [削除] ボタンをクリックします。