---
title: "API Workflow の利用シナリオ"
slug: "apiworkflow-procedure"
updated: 2026-09-17T09:23:26Z
published: 2026-09-17T09:23:26Z
canonical: "guide.ncloud-docs.com/apiworkflow-procedure"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://guide.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Workflow の利用シナリオ

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

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

## Step 1.API認証キー作成

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

1. NAVERクラウドプラットフォームコンソールにログインします。
2. コンソール画面右上の **My Account** > **アカウントとセキュリティ管理**メニューを順にクリックします。
3. パスワードを入力し、 **[確認]** ボタンをクリックします。
4. **セキュリティ管理** > **アクセス管理**メニューを順にクリックします。
5. **[新規 API認証キー作成]** ボタンをクリックします。
  - 既に作成済みの認証キーがある場合、その認証キーを使用
6. 作成された API認証キーの Access Key IDと Secret Keyを確認します。

              参考

              

- API認証キーは、NAVERクラウドプラットフォームの APIを使用する場合にのみ作成します。
- API認証キーの作成方法の詳細は、[API認証キーの作成](/docs/ja/apiworkflow-start#API%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1)をご参照ください。
- NCP Signature登録の詳細は、[NCP Signature登録](/docs/ja/apiworkflow-workflow#NCPSignature%EB%93%B1%EB%A1%9D)をご参照ください。

## Step 2.API登録

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

1. NAVERクラウドプラットフォームコンソールで、**Menu** > **All 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 ( json / xml) | Query | json | 有効化 |

              参考

              

API Workflowは基本的に json形式の responseに対して内部検索が可能なため、response typeを jsonに設定します。開始する月と終了する月は任意に設定できます。
8. URL項目の **[TEST]** ボタンをクリックし、正常に値を取得するか確認します。
9. **[保存]** ボタンをクリックします。

              参考

              

API登録方法の詳細は、[API Templateの登録と管理](/docs/ja/apiworflow-apitemplate)をご参照ください。

## Step 3.Workflow作成

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

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

              参考

              

API-1 Entityの Response項目のうち、Bodyの中の getDemandCostListResponse.totalRows値を totalRowプロパティに保存するようにという意味です。json bodyに限り、内部オブジェクトに対して key1.key2形式でアクセスできます。
  - Property: ${totalRow}
  - Entity: API-1, response, body
  - Key: getDemandCostListResponse.totalRows
9. 上記で作成した Entityの下の **[+]** > **if**をクリックし、IF条件文を追加します。

              参考

              

API-1 Entityで responseにより取得した値の totalRowが0より大きいか確認する条件文です。
  - Operand 1st: ${totalRow}
  - Comparison: >(Greater than)
  - Operand 2nd: 直接入力、0
10. IF Entityの下の **[+]** > **SetProperties**ボタンをクリックします。
              参考

              

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. **[Workflow作成]** ボタンをクリックします。

              参考

              

Workflow登録の詳細は、[Workflowの登録と管理](/docs/ja/apiworkflow-workflow)をご参照ください。

## Step 4.スケジューリング

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

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

              参考

              

Scheduleの詳細は、[自動実行スケジュールの設定](/docs/ja/apiworkflow-workflow#%EC%9E%90%EB%8F%99%EC%8B%A4%ED%96%89%EC%8A%A4%EC%BC%80%EC%A4%84%EC%84%A4%EC%A0%95)をご参照ください。