API Templateの登録と管理

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

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

APIの登録

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

API Templateを登録する方法は以下のとおりです。

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

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

3. 登録する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値を入力

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

   項目	説明
   Parameters	Key：Parameters Key値を入力 説明：Parametersの説明を入力 Type：Parametersのタイプを選択(デフォルト値：Query、URLでPathを使用すると自動でPathタイプが追加される) Default Value：デフォルト値を入力 Requried：必須かどうかを選択
   Headers	Key：Headers値を入力 説明：Headers値の説明を入力
   Body	Bodyの値を入力

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

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

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

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

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

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

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

APIの修正

登録したAPIの情報を修正する方法は以下のとおりです。

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

APIの削除

使用しなくなったAPIは削除できます。登録されたAPIを削除する方法は以下のとおりです。

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