API Workflow 이용 시나리오

Classic/VPC 환경에서 이용 가능합니다 .

API Workflow의 이용 시나리오를 설명합니다.

Step 1. API 인증키 생성

네이버 클라우드 플랫폼의 API를 활용하여 Workflow를 생성하려면 NCP Signature 인증을 완료해야 합니다. NCP Signature 인증 시 API 인증키의 Access Key ID 정보와 Secret Key 정보가 필요합니다. API 인증키를 생성하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 포털에 로그인해 주십시오.
2. 마이페이지 > 계정 관리 > 인증키 관리 메뉴를 클릭해 주십시오.
3. [신규 API 인증키 생성] 버튼을 클릭해 주십시오.
   • 이미 생성한 인증키가 있을 경우에는 해당 인증키 사용
4. 생성된 API 인증키의 Access Key ID와 Secret Key를 확인해 주십시오.

Step 2. API 등록

API의 이름, Method, URL, 요청 파라미터를 등록하여 새로운 API를 등록할 수 있습니다. 네이버 클라우드 플랫폼에서 제공하는 API인 경우에는 인증 방식을 NCP Signature로 선택하면 API Workflow에 등록된 Access Key, Secret Key를 통해 인증을 위한 Signature를 자동으로 생성할 수 있습니다. 사용 가능한 리전 목록 조회 API를 등록하는 방법을 기준으로 설명합니다.

1. 네이버 클라우드 플랫폼 콘솔에서 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. [저장] 버튼을 클릭해 주십시오.

Step 3. Workflow 생성

API Template에 등록된 API를 활용하여 Workflow를 생성합니다. 여러 Workflow를 조합한 Workflow를 생성하는 것도 가능합니다.
등록된 API를 활용하여 Workflow를 생성하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > API Workflow > Workflow 메뉴를 차례대로 클릭해 주십시오.
2. [Workflow 생성] 버튼을 클릭해 주십시오.
3. 생성할 워크플로우 이름을 입력해 주십시오.
4. 워크플로우 탭의 워크플로우 구성도에서 [+] > API을 클릭해 주십시오.
5. API Template의 [불러오기] 버튼을 클릭한 후, API Template 목록에서 '청구 비용 확인' API를 선택하고 [확인] 버튼을 클릭해 주십시오.
6. API Entity 아래의 [+] > Set properties를 클릭해 주십시오.
   • Property는 Workflow 실행에 필요한 특정 값을 저장할 수 있는 변수입니다.
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 아래의 [+] > SetProerties 버튼을 클릭해 주십시오.
    참고

    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 생성] 버튼을 클릭해 주십시오.

Step 4. 스케줄링

사용자가 구성한 Workflow를 원하는 주기에 따라 자동으로 실행할 수 있습니다. 매일 오전 10시 30분에 Workflow가 실행되도록 설정하는 방법은 다음과 같습니다.

1. 네이버 클라우드 플랫폼 콘솔에서 Services > Management & Governance > API Workflow > Workflow 메뉴를 차례대로 클릭해 주십시오.
2. Workflow를 선택한 후 [Schedule] 버튼을 클릭해 주십시오.
3. Schedule 설정 창이 나타나면 시작/종료 기간을 설정해 주십시오.
4. Cron expression 입력 영역에 '0 30 10 * * ?' 를 입력해 주십시오.
5. Request 정보를 입력해 주십시오.
6. [적용] 버튼을 클릭해 주십시오.