Classic/VPC環境で利用できます。
Workflowを構成するための APIを登録して管理するメニューです。新しい APIを登録したり、変更することができます。また、登録された APIの呼び出しテストを実行したり、使用しない APIは削除することもできます。APIを登録する段階でテストを行えるので、API呼び出し時に予測されるレスポンス結果をすぐさま確認できます。
API登録
APIの名前、Method、URL、リクエストパラメータを登録して新しい APIを登録できます。NAVERクラウドプラットフォームが提供する APIを登録する際に Authorityで NCP Signatureを選択すると、別途 Signature設定手続きなしで NAVERクラウドプラットフォームの APIを使用できます。
API Templateを登録する方法は、次の通りです。
-
NAVERクラウドプラットフォームコンソールで、Menu > All Services > Management & Governance > API Workflowメニューを順にクリックします。
-
API Templateメニューで [API Template登録] ボタンをクリックします。
-
登録する API情報を入力します。
項目 説明 名前 登録する API名を入力 URL 登録する APIの URLを入力
URLにhttps//url/{value}形式で入力すると、Parametersの Key値に{value}が自動的に入力される
API URLを入力した後、 [Test] ボタンをクリックして APIテストが行えるTag API検索時に使用するキーワードを入力。入力したタグごとに APIを分類できる Authority - 選択なし: NAVERクラウドプラットフォームまたは AWSで提供しない HTTPベースの APIの場合に選択
- NCP Signature: NAVERクラウドプラットフォームで提供する APIの場合に選択
- AWS Signature: AWSで提供する APIの場合に選択Request 呼び出す APIの Parameters値、Headers値、Body値を入力 -
Requestに Parameters、Headers、Body値を入力し、 [追加] ボタンをクリックします。
項目 説明 Parameters Key: Parameters Key値を入力
説明: Parametersの説明を入力
Type: Parametersタイプを選択(デフォルト値: Query、URLで Pathを使用すると、自動的に Pathタイプが追加される)
Default Value: デフォルト値を入力
Required: 必須の有無を選択Headers Key: Headers値を入力
説明: Headers値の説明を入力Body Bodyの値を入力 -
APIをテストするには、URLフィールドの [Test] ボタンをクリックします。
-
Test Request画面が表示されたら、 [Test] ボタンをクリックして結果を確認し、 [閉じる] ボタンをクリックします。
-
[保存] ボタンをクリックします。
-
APIリストを確認します。
登録された APIリストを確認
登録された APIを確認できます。Methodに応じてフィルタ機能を提供し、名前、URL、Tagを基準に検索できます。 登録された APIをクリックすると、その APIに関する詳細情報を確認できます。
登録された APIを確認する方法は、次の通りです。
- NAVERクラウドプラットフォームコンソールで、Menu > All Services > Management & Governance > API Workflowメニューを順にクリックします。
- API Templateメニューで登録された APIを確認します。
- 画面右上で URL、名前、Tagを基準に検索できます。
- 登録された APIの Methodを基準に検索できます。
API変更
登録した APIの情報を変更する方法は、次の通りです。
- NAVERクラウドプラットフォームコンソールで、Menu > All Services > Management & Governance > API Workflowメニューを順にクリックします。
- API Templateメニューをクリックして登録された APIリストを確認します。
- 変更する APIを選択し、 [変更] ボタンをクリックします。
- 変更画面が表示されたら、情報を変更して [Test] ボタンをクリックします。
- [保存] ボタンをクリックします。
API削除
使用しなくなった APIは削除できます。 登録された APIを削除する方法は、次の通りです。
- NAVERクラウドプラットフォームコンソールで、Menu > All Services > Management & Governance > API Workflowメニューを順にクリックします。
- API Templateメニューをクリックして登録された APIリストを確認します。
- 削除する APIを選択し、 [削除] ボタンをクリックします。
- 削除画面が表示されたら、 [削除] ボタンをクリックします。