API Workflowのシナリオ

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

API Workflowの利用シナリオを説明します。

Step 1. API認証キーの作成

NAVERクラウドプラットフォームのAPIを活用してワークフローを作成するには、NCP Signature認証を完了する必要があります。NCP Signature認証の際は、API認証キーのAccess Key ID情報とSecret Key情報が必要です。API認証キーを作成する方法は以下のとおりです。

1. NAVERクラウドプラットフォームポータルにログインします。
2. マイページ > アカウントの管理 > 認証キーの管理メニューをクリックします。
3. [新規API認証キーを作成] ボタンをクリックします。
   • 既に作成済みの認証キーがある場合、その認証キーを使用
4. 作成されたAPI認証キーのAccess Key IDとSecret Keyを確認します。

Step 2. APIの登録

APIの名前、Method、URL、リクエストパラメータを登録して新しいAPIを登録できます。NAVERクラウドプラットフォームが提供するAPIの場合、認証方式でNCP Signatureを選択すると、API Workflowに登録されたAccess Key、Secret Keyを利用して認証のためのSignatureを自動で作成できます。使用可能なリージョンリスト照会APIを登録する方法を基準に説明します。

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

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

3. 登録するAPIの名前に「請求費用確認」と入力します。

4. Methodを選択してURLを入力します。

   • Method：「GET」を選択
   • URL：「https://billingapi.apigw.ntruss.com/billing/v1/cost/getDemandCostList」と入力

5. Tagに「費用」を追加します。

6. AuthorityはNCP Signatureを選択します。

   • 認証情報がない場合、NCP Signatureの登録画面が表示されます。Step 1のAPI認証キー情報を入力します。

7. Request項目に呼び出すAPIのParameters情報を入力し、[追加] ボタンをクリックします。

   Key	説明	Type	Default value	Required
   startMonth	照会開始月(yyyymm)	Query	202204	有効化
   endMonth	照会終了月(yyyymm)	Query	202204	有効化
   responseFormatType	response type (JASON / XML)	Query	JASON	有効化

   参考

   API Workflowは、基本的にJSON形式の応答に対し内部検索が可能なので、応答形式をJSONに設定してください。開始する月と終了する月は任意に設定できます。

8. URL項目の [TEST] ボタンをクリックし、正常に値を取得するか確認します。

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

Step 3. ワークフローの作成

API Templateに登録されたAPIを活用してワークフローを作成します。複数のワークフローを組み合わせたワークフローを作成することもできます。
登録されたAPIを活用してワークフローを作成する方法は、以下のとおりです。

1. NAVERクラウドプラットフォームコンソールで、Services > Management & Governance > API Workflow > Workflowメニューを順にクリックします。
2. [ワークフローを作成] ボタンをクリックします。
3. 作成するワークフローの名前を入力します。
4. ワークフロータブのワークフロー構成図で [+] > APIをクリックします。
5. API Templateの [読み込み] ボタンをクリックし、API Templateリストで「請求費用確認」 APIを選択して [確認] ボタンをクリックします。
6. API Entityの下の [+] > Set properties をクリックします。
   • Propertyは、ワークフローの実行に必要な特定の値を保存できる変数です。
7. [Property] タブの [+追加] をクリックし、請求費用リスト数を保存するIntegerタイプの「totalRow」を作成します。
8. Property情報を設定し、[追加] ボタンをクリックします。
   • Property：${totalRow}
   • Entity: API-1、response、body
   • Key：getDemandCostListResponse.totalRows
   参考

   API-1 EntityのRespone項目のうち、Bodyの中のgetDemandCostListResponse.totalRows値をtotalRowプロパティに保存するようにという意味です。JSON Bodyに限り、内部オブジェクトに対してkey1.key2形式でアクセスできます。

9. 上記で作成したEntityの下の [+] > ifをクリックし、IF条件文を追加します。
   • Operand 1st：${totalRow}
   • Comparison：>(Greater than)
   • Operand 2nd：直接入力、0
   参考

   API-1 Entityでresponseにより取得した値のtotalRowが0より大きいか確認する条件文です。

10. IF Entityの下の [+] > Set propertiesボタンをクリックします。
    参考

    SetPropertiesがIFの下位に位置する場合、IF条件文が真(true)の時に下位Entityを実行するようにという意味です。

11. [Property] タブの [+追加] ボタンをクリックし、IntegerタイプのuseAmountとStringタイプのrequestIdを追加します。
    • useAmount：請求費用を保存
    • requestId：クエストIDを保存
12. Property情報を設定します。

    Property	Entity	Key
    useAmount	API-1, response, body	getDemandCostListResponse.demandCostList.useAmount
    requestId	API-1, response, body	etDemandCostListResponse.requestId

13. Finish Entityをクリックし、Bodyに以下のように入力します。

    {
        "useAmount" : ${useAmount},
        "requestId":"${requestId}"
    }
    

    参考

    • Finish Entityに設定したヘッダとボディは、最終結果値を入れるのに用いられます。ワークフローのエンドポイントを呼び出すと、このFinish Entityのヘッダとボディを返します。
    • Propertiesの値を${propertyKey}形式で入力すると、Propertiesのvalueに置き換えられます。
14. 構成したワークフローが正常に動作するか確認するには、[テストを実行] ボタンをクリックします。
    • Finishに請求費用とrequestId情報が入るか確認します。
    • エラーが発生した場合、そのEntityをクリックすると詳細なエラーメッセージを確認できます。
15. [ワークフローを作成] ボタンをクリックします。

Step 4. スケジューリング

ユーザーが構成したワークフローを希望する周期に従って自動で実行できます。毎日午前10時30分にワークフローが実行されるように設定する方法は、以下のとおりです。

1. NAVERクラウドプラットフォームコンソールで、Services > Management & Governance > API Workflow > Workflowメニューを順にクリックします。
2. ワークフローを選択し、[Schedule] ボタンをクリックします。
3. スケジュールの設定画面が表示されたら、開始・終了期間を設定します。
4. Cron expression入力領域に「0 30 10 * * ?」と入力します。
5. Request情報を入力します。
6. [適用] ボタンをクリックします。