알림 템플릿을 사용하여 알림 설정

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

알림 템플릿이란 무엇인가요?

수익 창출에서는 다양한 유형의 이벤트 알림의 샘플 텍스트를 정의하는 일련의 템플릿을 제공합니다. 이러한 템플릿은 다음과 같이 맞춤설정할 수 있습니다.

  • 모든 개발자에게 신제품, 새 이용약관, 새 요금제 등의 이벤트를 알립니다.
  • 영향을 받는 개발자에게 수정 요금제와 같은 이벤트를 알립니다.
  • 개발자가 계정에 등록하는 경우 또는 개발자가 요금제에 가입하는 경우와 같은 개발자 관련 이벤트를 API 제공업체에 알립니다.
  • 모든 회사 관리자에게 특정 이벤트를 알립니다.

또는 HTTP 콜백 핸들러를 정의하는 웹훅을 만든 후 웹훅을 사용하여 알림 설정에 설명된 대로 웹훅을 트리거하는 조건을 구성할 수 있습니다.

알림 페이지 살펴보기

아래에 설명된 대로 알림 페이지에 액세스합니다.

에지

Edge UI를 사용하여 알림 페이지에 액세스하려면 다음 단계를 따르세요.

  1. apigee.com/edge에 로그인합니다.
  2. 왼쪽 탐색 메뉴에서 게시 > 수익 창출 > 알림을 선택합니다.

알림 페이지가 표시됩니다.

그림에 강조표시된 것처럼 알림 페이지에서는 다음 작업을 할 수 있습니다.

Classic Edge (Private Cloud)

기본 Edge UI를 사용하여 알림 페이지에 액세스하려면 다음 단계를 따르세요.

  1. http://ms-ip:9000에 로그인합니다. 여기서 ms-ip는 관리 서버 노드의 IP 주소 또는 DNS 이름입니다.
  2. 상단 탐색 메뉴에서 관리 > 알림을 선택합니다.

알림 페이지에서는 다음 작업을 할 수 있습니다.

알림 수정

UI를 사용하여 알림을 수정하려면 다음 단계를 따르세요.

  1. 알림 페이지에 액세스합니다.
  2. 수정하려는 알림 옆에 있는 를 클릭하여 세부정보를 펼칩니다.
  3. 필요에 따라 제목, 본문, 수신자 (해당하는 경우) 입력란을 수정합니다.

    알림 템플릿 내에서 지정할 수 있는 변수에 대한 자세한 내용은 알림 템플릿에서 변수 사용을 참고하세요.

    각 카테고리의 알림 수정에 관한 자세한 내용은 다음 섹션을 참고하세요.

  4. 알림 옆의 체크박스를 선택하여 알림을 사용 설정합니다.
  5. 추가 알림을 수정하려면 2~4단계를 반복합니다.
  6. 저장을 클릭하여 모든 변경사항을 저장합니다.

알림이 저장되었음을 확인하는 메시지가 표시됩니다. 저장 작업은 몇 분 정도 걸릴 수 있습니다.

모든 개발자에게 알리도록 알림 수정

모든 개발자에게 알림 섹션에서 선택한 이벤트 유형에 관한 알림이 모든 개발자에게 전송됩니다.

알림은 하루가 끝날 때 실행되도록 예약되어 있습니다. 알림이 전송된 후 이벤트 체크박스가 자동으로 지워집니다. 연결된 이벤트 유형에 대한 알림을 예약하려면 이벤트를 다시 선택해야 합니다.

다음 표에는 모든 개발자에게 알림 섹션의 이벤트 유형에 따른 알림이 나와 있습니다. 자세한 내용은 UI를 사용하여 알림 수정을 참조하세요.

이벤트 유형 트리거 Notes
새 패키지 새 API 패키지 사용 가능

업데이트 중에 각 새 패키지 (및 각 패키지에 포함된 제품)의 이름을 이메일 템플릿 본문에 추가합니다. 개발자 포털이나 알림에 관한 자세한 정보를 제공하는 다른 웹사이트의 링크를 추가할 수도 있습니다.

신제품 새로운 API 제품을 사용할 수 있습니다.

업데이트 과정에서 각 새 제품의 이름을 이메일 템플릿 본문에 추가합니다. 개발자 포털이나 알림에 관한 자세한 정보를 제공하는 다른 웹사이트의 링크를 추가할 수도 있습니다.

신규 시장/노출 범위 특정 지역의 시장에서 새로운 API 제품을 사용할 수 있습니다.

업데이트의 일부로 각 신규 시장 및 관련 제품의 이름을 이메일 템플릿 본문에 추가합니다. 개발자 포털이나 알림에 관한 자세한 정보를 제공하는 다른 웹사이트의 링크를 추가할 수도 있습니다.

영향을 받는 개발자에게 알리기 위한 알림 수정

영향을 받는 개발자에게 알림 섹션에서 선택한 이벤트 유형에 관한 알림은 이러한 유형의 이벤트의 영향을 받는 개발자에게만 전송됩니다. 예를 들어 수정된 요금제 이벤트를 선택하면 요금제에 동의한 개발자에게만 알림이 전송됩니다.

다음 표에는 영향을 받는 개발자에게 알림 섹션의 이벤트 유형에 따른 알림이 나와 있습니다. 자세한 내용은 UI를 사용하여 알림 수정을 참조하세요.

이벤트 유형 트리거 Notes
이용약관에 동의하지 않거나 만료됨 새로운 이용약관이 게시되었으며 개발자가 아직 수락하지 않았습니다.

이 알림은 새 이용약관이 적용되기 30일, 7일, 1일 전에 전송됩니다.

새 요금제 새 요금제가 게시되었습니다.

요금제가 다음과 같은 경우:

  • 스탠더드 요금제, 모든 개발자에게 알림이 전송됩니다.
  • 개발자 카테고리 요금제입니다. 해당 카테고리에 속한 개발자에게만 알림이 전송됩니다.
  • 개발자 요금제: 특정 개발자에게만 알림이 전송됩니다.
요금제 수정됨 구매한 요금제의 최신 버전을 사용할 수 있습니다.

현재 버전을 구매한 개발자에게만 알림이 전송됩니다. 개발자는 이 알림을 통해 새 버전을 검토할 수 있으며, 새 요금을 수락하고 싶지 않은 경우 요금제를 종료하거나 전환할 수 있습니다.

만료된 요금제 요금제가 후속 요금제 없이 만료됨

요금제가 만료되도록 처음 설정하면 이 알림이 전송되며 만료일 30일, 7일, 1일 전에 추가 알림이 전송됩니다. 만료되는 요금제를 구매한 개발자에게만 알림이 전송됩니다.

요금제 갱신 요금제 구독이 갱신되었습니다.

개발자에게 관련 수수료가 청구된다고 알립니다.

속도 제한 초과 요금제 한도를 초과했습니다.

개발자에게 관련 수수료가 청구된다고 알립니다.

부분 유료 모델 요금제 소진됨 트랜잭션 수 또는 일수로 측정되는 무료 사용 기간이 소진됨

무료 사용 기간은 부분 유료화 요금제에 따라 정의됩니다.

결제 문서가 게시되었습니다.

개발자의 결제 문서 (예: 인보이스)를 사용할 수 있습니다.

개발자가 새로운 요금제를 신청함 개발자가 새 요금제를 신청합니다.

API 제공업체에 알림 수정

알림 API 제공업체 섹션에서 선택한 이벤트 유형에 대한 알림이 지정된 API 제공업체로 전송됩니다.

다음 표에는 Notify API Provider 섹션의 이벤트 유형에 따른 알림이 나와 있습니다. 자세한 내용은 UI를 사용하여 알림 수정을 참조하세요.

이벤트 유형 트리거
신규 개발자 가입

개발자가 계정을 등록했습니다.

개발자가 앱을 추가한 경우

개발자가 새 애플리케이션을 만들었습니다.

개발자가 새 요금제 가입

개발자가 요금제에 가입했습니다.

개발자가 변경 재무 세부정보

개발자가 회사 이름 또는 회사 주소와 같은 재무 세부정보를 변경했습니다.

알림 사용 설정 또는 중지

UI를 사용하여 알림을 사용 설정 또는 중지하려면 다음 안내를 따르세요.

  1. 알림 페이지에 액세스합니다.
  2. 알림 옆에 있는 체크박스를 선택하거나 선택 해제하여 알림을 사용 설정 또는 사용 중지합니다.
  3. 저장을 클릭하여 모든 변경사항을 저장합니다.

저장 작업은 몇 분 정도 걸릴 수 있습니다. 알림이 저장되었음을 확인하는 메시지가 표시됩니다.

API를 사용하여 템플릿을 사용하여 알림 설정

다음 섹션에 설명된 대로 API를 사용하여 알림을 설정합니다.

API를 사용하여 알림 템플릿 관리

다음 섹션에 설명된 대로 API를 사용하여 알림 템플릿을 관리합니다.

API를 사용하여 모든 알림 템플릿 보기

/mint/organizations/{org_name}/notification-email-templates에 GET 요청을 실행하면 수익 창출에서 제공하는 모든 알림 템플릿을 나열할 수 있습니다. 예를 들면 다음과 같습니다.

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

예를 들어 다음은 개발자에게 새로운 API 제품의 제공 여부를 알리는 이벤트 템플릿입니다.

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

API를 사용하여 알림 템플릿 보기

/mint/organizations/{org_name}/notification-email-templates/{template_id}에 GET 요청을 실행하여 알림 템플릿을 확인합니다. 여기서 {template_id}는 템플릿의 ID입니다. 예를 들면 다음과 같습니다.

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

$로 시작하는 템플릿의 항목은 변수입니다. 자세한 내용은 알림 템플릿에서 변수 사용을 참고하세요. 알림의 변수가 다음 값으로 평가된다고 가정해 보겠습니다.

  • ${developer.legalName}.XYZ company
  • ${developer.name}.DEV1
  • ${QUOTA_TYPE}.Transactions
  • ${PERCENT}.90%
  • ${QUOTA_UNIT}.Calls
  • ${QUOTA_LIMIT}.100
  • ${ratePlan.monetizationPackage.products.name}.X
  • ${EXPIRY_DATE}.2016-09-30

템플릿에서 제공되는 알림 메시지는 다음과 같습니다.

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

API를 사용하여 알림 템플릿 수정

/nint/organizations/{org_name}/notification-email-templates/{template_id}에 PUT 요청을 실행하여 알림 템플릿을 수정합니다. 템플릿의 변경된 콘텐츠를 요청 본문에 제공합니다.

알림 템플릿의 메시지를 맞춤설정할 때 하나 이상의 변수를 포함할 수 있습니다. 자세한 내용은 알림 템플릿에서 변수 사용을 참고하세요.

예를 들어 다음 요청은 새 API 제품 알림의 내용을 수정합니다.

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

API를 사용하여 알림 조건 및 작업 관리

다음 섹션에 설명된 대로 API를 사용하여 알림 조건 및 작업을 관리하세요.

API를 사용하여 알림 조건 및 작업 만들기

/mint/organizations/{org_name}/notification-conditions에 POST 요청을 실행하여 자동 알림을 유발하는 알림 조건 및 작업을 만듭니다.

요청 시 알림으로 이어지는 조건과 조건에 도달할 때 수행할 작업 (예: 알림 이메일 전송)을 요청 본문에 지정합니다.

하나 이상의 속성 값을 지정하여 알림 조건의 세부정보를 정의합니다. 속성 목록은 알림 조건 구성 속성을 참고하세요. 이벤트 알림의 경우 새 제품이 게시될 때 조건이 트리거될 수 있습니다.

actions를 정의할 때 관련 알림 템플릿을 참조합니다. 작업 목록은 알림 작업 구성 속성을 참고하세요.

예를 들어 다음 요청에서는 속성이 NEW_PRODUCT이고 PUBLISHED 속성의 값이 true인 경우 ID가 01191bf9-5fdd-45bf-8130-3f024694e63 (DEFAULT_NEW_PRODUCT_TEMPLATE)인 템플릿에서 알림을 전송하도록 지정합니다.

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

API를 사용하여 알림 조건 및 작업 보기

organizations/{org_name}/notification-conditions/{condition_Id}에 GET 요청을 실행하여 알림 조건과 작업을 확인합니다. 여기서 {condition_Id}는 조건 ID입니다. 알림 조건을 만들 때 ID가 반환됩니다. 예를 들면 다음과 같습니다.

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

다음은 응답의 예시입니다.

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

API를 사용하여 알림 조건 및 작업 수정

organizations/{org_name}/notification-conditions/{condition_Id}에 POST 요청을 실행하여 알림 조건 및 작업을 수정합니다. 여기서 {condition_Id}는 조건 ID입니다. 알림 조건을 만들 때 ID가 반환됩니다. 요청을 실행할 때 알림 조건이나 작업에 적용할 변경사항을 요청 본문에 지정합니다.

예를 들면 다음과 같습니다.

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

API를 사용하여 알림 조건 및 작업 삭제

organizations/{org_name}notification-conditions/{condition_Id}에 DELETE 요청을 실행하여 알림 조건을 삭제합니다. 예를 들면 다음과 같습니다.

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

알림 조건의 구성 속성

API를 사용하는 경우 알림 조건에 대한 다음 구성 속성을 사용할 수 있습니다.

이름 설명 기본 계정 필수 여부
attribute

알림 조건의 세부정보입니다. 속성을 하나 이상 지정하여 알림 조건을 미세 조정할 수 있습니다.

값은 다음 중 하나 이상일 수 있습니다.

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (웹훅 구성에만 유효)
N/A 지원됨
value

속성의 값입니다.

N/A No
associatedCondition

연결된 조건에 대한 참조입니다.

N/A No

알림 작업의 구성 속성

API를 사용할 때 알림 작업에 사용할 수 있는 구성 속성은 다음과 같습니다.

이름 설명 기본 계정 필수 여부
actionAttribute

알림 수신자를 식별하는 데 사용되는 메서드입니다. 값은 다음 중 하나 이상일 수 있습니다.

  • ORG_EMAIL. 알림 수신자는 이메일 주소로 식별됩니다.
  • DEV_ID. 알림 수신자는 개발자 ID (이메일 주소)로 식별됩니다.
  • COMPANY_ADMINS. 설정된 값과 관계없이 모든 회사 관리자에게 알림이 전송됩니다. 회사 관리자는 조직 관리자와 다릅니다.
  • WEBHOOK. 알림 수신자 정보가 웹훅 콜백 핸들러로 전송됩니다. 웹훅을 사용하여 알림 설정을 참조하세요.
N/A 지원됨
value

액션 속성의 값입니다.

actionAttributeORG_EMAIL 또는 DEV_ID로 설정된 경우 값 ANY는 적용 가능한 수신자에게 알림을 전송합니다(예: ORG_EMAIL 주소 또는 모든 DEV_ID).

actionAttributeWEBHOOK로 설정되면 이 값을 웹훅 ID로 설정합니다.

actionAttributeCOMPANY_ADMINS로 설정하면 이 값이 무시됩니다. 알림이 모든 회사 관리자에게 전송됩니다.

N/A 지원됨
templateID

알림 템플릿의 ID입니다.

참고: 이 옵션은 actionAttributeWEBHOOK로 설정된 경우에는 유효하지 않습니다.

N/A 지원됨
postURL

웹훅의 콜백 핸들러입니다.

참고: actionAttributeWEBHOOK로 설정된 경우 이 옵션이 필요합니다. 이 옵션은 값이 ORG_EMAIL, DEV_ID 또는 COMPANY_ADMINS로 설정된 경우 유효하지 않습니다.

N/A 지원됨

알림 템플릿에서 변수 사용

알림 템플릿의 메시지를 수정할 때 Spring Expression Language (SpEL)를 사용하여 트랜잭션 객체에 반환된 값을 나타내는 변수를 하나 이상 포함할 수 있습니다.

다음 표에는 가장 일반적으로 사용되는 알림 템플릿 변수가 요약되어 있습니다.

변수 설명
${application.name}

애플리케이션의 이름입니다.

${application.products.name} 애플리케이션에 포함된 제품의 이름입니다.
${BALANCE} 지정된 할당량의 잔액입니다.
${developer.legalName}

개발자 회사 이름입니다.

${developer.name}

개발자 이름입니다.

${EXPIRY_DATE}

한도가 만료되거나 재설정되는 날짜 또는 시간입니다.

${LONG_PERCENT} 현재 사용량으로 도달한 한도의 비율(% 기호 없음)입니다. 예: 50
${PERCENT}

현재 사용량으로 도달한 한도의 비율(% 기호)입니다. 예: 50%

${products.displayName} 제품에 정의된 표시 이름입니다.
${QUOTA_TYPE}

한도 유형 (거래량, 지출 한도 또는 수수료 노출)입니다.

${QUOTA_UNIT}

한도의 기본 단위: 통화 (지출 한도) 또는 호출 (거래 한도)

${QUOTA_LIMIT}

한도 금액입니다.

${ratePlan.displayName} 요금제에 정의된 표시 이름입니다.
${ratePlan.endDate} API 제공업체에서 요금제를 종료한 날짜입니다.
${ratePlan.monetizationPackage.displayName}

API 패키지의 이름입니다.

${ratePlan.monetizationPackage.name} 수익 창출 패키지의 이름입니다.
${ratePlan.monetizationPackage.products.displayName}

API 제품에 정의된 표시 이름입니다.

${ratePlan.monetizationPackage.products.name} 수익 창출 패키지에 포함된 제품의 이름입니다.
${ratePlan.startDate} 요금제를 만든 날짜입니다.
${USAGE} 현재 사용량 (총 수익 또는 청구 금액 또는 볼륨)
${USER}

사용자의 이름입니다.

답장 이메일 주소 맞춤설정하기

수익 창출을 위해 회사와 개발자에게 전송되는 이메일 알림에 사용하도록 기본 noreply@apigee.com 주소가 구성됩니다. 조직의 커스텀 답장 이름과 주소를 구성하려면 Apigee 지원팀에 문의하세요.