API 트리거를 사용하는 Apigee Integration

이 빠른 시작에서는 Apigee Integration에서 샘플 통합을 만드는 방법을 보여줍니다. 아래 단계는 전체 통합을 실행하는 데 필요한 트리거, 태스크, 에지, 변수, 데이터 매핑을 구성하는 방법을 설명합니다.

이 빠른 시작에서는 공개 API에서 페이지 조회수를 검색하고, 데이터를 사용 가능한 형식으로 변환하고, 결과 목록을 이메일로 전송하며 전부 통합 디자이너 내에서 이루어집니다.

새 통합 만들기

새 통합을 만들려면 다음 단계를 수행합니다.

  1. Apigee UI에서 Apigee 조직을 선택합니다.
  2. 개발 > 통합을 클릭합니다.
  3. 통합 만들기를 클릭합니다.
  4. 통합 만들기 대화상자에 이름과 설명을 입력합니다.

    이 빠른 시작에서는 my-test-integration 이름과 Integration for quickstart 설명을 입력합니다.

  5. 통합 리전을 선택합니다.
  6. 만들기를 클릭하여 통합 편집기를 엽니다.

API 트리거 추가 및 구성

트리거는 통합을 구성하는 태스크의 시퀀스를 시작하는 데 필요합니다. 사용 가능한 모든 트리거를 사용하여 통합을 시작할 수 있습니다. 빠른 시작을 위해 API 트리거를 사용합니다.

API 트리거를 구성하려면 다음 안내를 따르세요.

  1. 통합 편집기에서 트리거를 클릭하여 사용 가능한 트리거 목록을 표시합니다.
  2. 통합 편집기에서 API 트리거 요소를 클릭하여 배치합니다.
  3. 디자이너에서 API 트리거 요소를 클릭하여 트리거 구성 창을 엽니다.
  4. Apigee Integration은 트리거 라벨, 트리거 이름, 트리거 ID를 자동으로 채웁니다. 트리거 ID는 머신이 생성하며 값을 수정할 수 없습니다. 그러나 라벨 및 트리거 이름 속성 값은 수정할 수 있습니다.

    속성 변경사항은 자동으로 저장됩니다.

태스크 추가 및 구성

태스크는 변수를 입력으로 사용하고 변수를 출력으로 생성할 수 있는 실행 가능한 단계 집합입니다. 트리거와 마찬가지로 사용 가능한 모든 태스크를 통합에 사용할 수 있습니다. 이 빠른 시작에서는 REST 엔드포인트 호출, 데이터 매핑, 이메일 보내기 태스크를 사용합니다. 각 태스크의 구성 세부정보는 아래 단계에서 설명합니다.

REST 엔드포인트 호출 태스크 구성

REST 엔드포인트 호출 태스크를 구성하려면 다음 안내를 따르세요.

  1. 태스크를 선택하여 사용 가능한 태스크 목록을 표시합니다.
  2. 통합 편집기에서 REST 엔드포인트 호출 요소를 클릭하여 배치합니다.
  3. API 트리거 요소의 제어 지점에 마우스를 가져간 뒤 클릭한 다음 REST 엔드포인트 호출 태스크 요소의 제어 지점으로 선을 드래그하여 API 트리거 요소에서 REST 엔드포인트 호출 요소로 에지 연결을 추가합니다. 에지는 API 트리거에서 REST 엔드포인트 호출 태스크로의 제어 흐름을 나타냅니다.

    에지는 통합에서 두 요소 간의 연결입니다. 연결은 한 요소(태스크 또는 트리거)에서 다른 요소로 제어 흐름의 방향을 나타냅니다. 에지에 대한 자세한 내용은 에지를 참조하세요.

  4. 디자이너에서 REST 엔드포인트 호출 요소를 클릭하여 태스크 구성 창을 엽니다. 다음 속성을 설정합니다.
    • 라벨: 이 태스크의 커스텀 이름을 입력합니다. 예를 들어 Call REST Endpoint Task를 입력합니다.
    • 인증: 이 빠른 시작에서는 인증 프로필이 필요하지 않습니다. 다른 사용 사례에 인증 프로필을 사용하는 방법에 대한 상세 설명은 Apigee Integration에서 인증 프로필 만들기를 참조하세요.
    • 태스크 입력: REST 엔드포인트 호출 세부정보를 입력합니다. 여기에 입력한 정보는 REST 엔드포인트 호출 태스크의 입력으로 사용됩니다. 다음 정보를 입력합니다.
      • 엔드포인트 기준 URL: https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031을 입력합니다. wikimedia.org의 이 공개 API는 특정 월의 Tree라는 기사의 페이지 조회수를 반환합니다.
      • HTTP 메서드: 드롭다운 목록을 사용하여 GET을 선택합니다.
    • 태스크 출력: 여기에서 Apigee Integration은 REST 엔드포인트 호출의 응답 데이터 출력을 저장할 세 개의 변수를 채웁니다.
      • responseHeader(REST 엔드포인트 호출): 이 변수는 REST 엔드포인트 호출 태스크와 연결된 응답 헤더 데이터를 저장합니다. 변수 데이터는 String(STR) 유형입니다.
      • responseBody(REST 엔드포인트 호출): 이 변수는 REST 엔드포인트 호출 태스크와 연결된 응답 본문 데이터를 저장합니다. 변수 데이터는 String(STR) 유형입니다.
      • responseStatus(REST 엔드포인트 호출): 이 변수는 REST 엔드포인트 호출 태스크와 연결된 응답 상태 데이터를 저장합니다. 변수 데이터는 String(STR) 유형입니다.
    • 태스크 구성 창에서 변수 이름을 클릭하여 각 변수의 세부정보를 확인합니다. 이 빠른 시작에서는 이러한 변수의 기본값을 그대로 둡니다.
    • 나머지 필드는 다음 기본값을 포함해야 합니다.
      • 리디렉션 따르기: True
      • HTTP 오류 발생 시 태스크 실패: False
      • 오류 처리 전략
        • 동기 실행 전략: None
        • 비동기 실행 전략: None

    속성 변경사항은 자동으로 저장됩니다.

데이터 매핑 태스크 추가 및 구성

데이터 매핑 태스크를 구성하려면 다음 안내를 따르세요.

  1. 태스크를 선택하여 사용 가능한 태스크 목록을 표시합니다.
  2. 데이터 매핑 요소를 클릭하고 통합 편집기에 배치합니다.
  3. REST 엔드포인트 호출 요소의 제어 지점에 마우스를 가져간 뒤 클릭한 다음 데이터 매핑 태스크 요소의 제어 지점으로 선을 드래그하여 REST 엔드포인트 호출 요소에서 데이터 매핑 요소로 에지 연결을 추가합니다. 에지는 REST 엔드포인트 호출 태스크에서 데이터 매핑 태스크로의 제어 흐름을 나타냅니다.
  4. 디자이너에서 데이터 매핑 태스크를 클릭하여 태스크의 구성 창을 엽니다.
  5. 데이터 매핑 편집기 열기를 클릭합니다.

    데이터 매핑 편집기를 사용하면 사용 가능한 변환 함수를 사용하여 원하는 출력 변수에 입력 변수를 매핑할 수 있습니다. 그러면 출력을 다른 통합 태스크 또는 트리거에 변수로 사용할 수 있습니다. 데이터를 변수로 전달하는 방법에 대한 자세한 내용은 Apigee Integration에서 변수 사용을 참조하세요.

    이 빠른 시작에서는 responseBody(Call REST Endpoint)를 입력으로 사용하여 매핑을 만듭니다.

    1. responseBody 창에서 responseBody 변수를 첫 번째 responseBody 행으로 드래그합니다.
    2. responseBody 변수 칩에서 +(함수 추가)를 클릭하여 사용 가능한 함수의 드롭다운 목록을 확인합니다.
    3. 여러 함수를 적용하여 입력 변수의 데이터를 변환할 수 있습니다.

      여기에서는 페이로드를 JSON으로 변환한 후 응답 배열을 반복하여 이메일 알림에 필요한 제품 이름 목록을 가져올 수 있습니다.

      • TO_JSON()을 선택하여 responseBody 문자열을 JSON으로 변환합니다.
      • responseBody 변수 칩에서 +(함수 추가)를 클릭하여 GET_PROPERTY() 함수를 선택하고 연결합니다.
      • GET_PROPERTY()의 입력 매개변수를 추가하려면 변수 또는 값을 클릭하고 값에 items을 입력합니다.

        이 함수는 JSON 페이로드에서 속성을 추출합니다. items 속성에 이 함수의 매개변수로 전달합니다. 이렇게 하면 다른 제품 정보 없이 제품 이름 목록만 반환합니다. 함수는 다음과 같아야 합니다. 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)

      • 함수를 삭제하거나 삭제하려면 - 기호를 클릭합니다.
    4. 출력 열의 첫 번째 필드를 클릭하여 변환된 데이터 값을 저장할 새 출력 변수를 만듭니다. 다음 입력란을 작성하세요.
      • 이름: JSONList를 입력합니다.
      • 데이터 유형: JSON
      • 통합의 출력으로 사용 체크박스를 선택합니다.
      • 만들기를 클릭하여 변수를 만들고 창을 닫습니다. 새로운 JSONList 변수가 데이터 매핑 편집기 왼쪽에 있는 JSONList 목록에 표시됩니다.
    5. 매핑이 완료되면 데이터 매핑 편집기를 닫습니다. 모든 변경사항이 자동 저장됩니다.

이메일 보내기 태스크 추가 및 구성

이메일 보내기 태스크를 구성하려면 다음 안내를 따르세요.

  1. 통합 편집기에서 태스크를 선택하여 사용 가능한 태스크 목록을 표시합니다.
  2. 이메일 보내기 태스크 요소를 클릭하고 통합 편집기에 배치합니다.
  3. 데이터 매핑 요소의 제어 지점에 마우스를 가져간 뒤 클릭한 다음 이메일 보내기 태스크 요소의 제어 지점으로 선을 드래그하여 데이터 매핑 요소에서 이메일 보내기 요소로 에지 연결을 추가합니다. 에지는 데이터 매핑 태스크에서 이메일 보내기 태스크로의 제어 흐름을 나타냅니다.
  4. 디자이너에서 이메일 보내기 요소를 클릭하여 태스크 구성 창을 엽니다. 다음 속성을 설정합니다.
    • 수신자: 이메일 주소를 입력합니다. 이 이메일을 사용하여 통합 완료를 확인합니다.
    • 제목: Email from Apigee Integration를 입력합니다.
    • 일반 텍스트 본문: 앞서 데이터 매핑 태스크에서 만든 JSONList 변수를 선택합니다.
    • 나머지 옵션은 기본 구성에서 남겨둘 수 있습니다.

    속성 변경사항은 자동으로 저장됩니다.

필수 에지 연결 확인

통합의 요소 간에 에지 연결을 추가했는지 확인합니다. 연결은 한 요소(태스크 또는 트리거)에서 다른 요소로 제어 흐름의 방향을 나타냅니다. 에지에 대한 자세한 내용은 에지를 참조하세요.

완료된 연결은 아래 그림과 같이 표시됩니다.

빠른 시작 흐름을 보여주는 이미지 빠른 시작 흐름을 보여주는 이미지

통합 테스트

새 통합을 테스트하려면 다음 단계를 따르세요.

  1. 통합 편집기 툴바에서 테스트를 클릭합니다.

    통합 테스트 창이 나타납니다.

  2. 통합 테스트를 클릭합니다.

테스트에 대한 자세한 내용은 통합 테스트 및 게시를 참조하세요.

성공적으로 완료되면 통합은 JSON 값이 포함된 이메일을 이메일 보내기 태스크에 지정된 이메일 주소로 보냅니다. 이메일 클라이언트에서 이메일 수신 여부를 확인합니다.

통합에서 전송한 이메일에는 다음과 비슷한 본문이 포함되어야 합니다. 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

이메일의 내용을 확인하는 것 외에도 로그를 검사하여 지정된 통합의 상태와 페이로드를 확인할 수 있습니다. 로그를 보려면 다음 안내를 따르세요.

  1. 통합 편집기의 툴바에서 로그를 클릭합니다.
  2. 실행 로그 페이지에서 통합 실행 시도에 대한 세부정보를 볼 수 있습니다. 각 항목에는 다음을 포함하여 실행 시도에 대한 세부정보가 포함됩니다.
    • 통합 이름
    • 실행 ID
    • 상태
    • 시작 시간
    • 기간
    • 통합 버전
    • 트리거 ID
  3. 실행된 통합 옆의 확장 화살표(>)를 클릭하여 통합에 있는 태스크 및 변수의 확장된 목록과 태스크 상태 및 변수 페이로드를 확인합니다.