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

<ph type="x-smartling-placeholder"></ph> 현재 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를 사용하여 알림 수정을 참조하세요.

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

각각의 새 패키지 (및 각 패키지에 포함된 제품)의 이름을 이메일 템플릿의 본문을 확인하세요. 또한 보다 자세한 정보를 제공하는 개발자 포털 또는 기타 웹사이트를 있습니다.

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

이메일 템플릿 본문에 각 새 제품의 이름을 업데이트. 또한 개발자 포털이나 알림에 대한 자세한 정보를 제공합니다.

신규 시장/노출 범위 새로운 API 제품은 특정 지리적 시장에서 제공됩니다.

새 시장 및 관련 제품의 이름을 이메일 본문에 각각 추가합니다. 템플릿에 추가하는 것이 좋습니다. 개발자 포털이나 신고에 대한 자세한 정보를 제공하는 다른 웹사이트를 확인하시기 바랍니다.

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

영향을 받는 알림 보내기'에서 선택한 이벤트 유형에 대한 알림 개발자 섹션은 해당 유형의 이벤트의 영향을 받는 개발자에게만 전송됩니다. 예를 들어 개정된 요금제 이벤트를 선택하면 알림이 오직 요금제를 수락한 개발자

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

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

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

새 요금제 새 요금제가 게시됨

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

  • Standard 요금제의 경우 모든 개발자에게 알림이 전송됩니다.
  • 개발자 카테고리 요금제의 경우 해당 카테고리의 개발자만 알림을 받습니다.
  • 개발자 요금제의 경우 특정 개발자에게만 알림이 전송됩니다.
수정된 요금제 구매한 요금제의 최신 버전을 사용할 수 있습니다.

현재 버전을 구매한 개발자에게만 알림이 전송됩니다. 이 알림을 통해 개발자는 새 버전을 검토하고 새 요금을 수락하지 않으려는 경우

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

처음에 요금제가 만료되도록 설정한 경우 이 알림이 전송됩니다. 만료일 30, 7, 1일 전에 추가 알림이 전송되었습니다. 다음 항목만 요금제를 구매한 개발자에게 만료된다는 알림이 전송됩니다.

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

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

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

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

고갈된 부분 유료화(Freemium) 요금제 트랜잭션 수 또는 일수로 측정된 무료 사용 기간이 소진되었습니다.

무료 사용 기간은 부분 유료 요금제로 정의됩니다.

결제 문서 게시됨

개발자의 결제 문서 (예: 인보이스)가 제공됩니다.

개발자가 새 요금제 가입 개발자가 새 요금제에 가입합니다.

Notify API 제공업체에 대한 알림 수정

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

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

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

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

개발자가 앱 추가

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

개발자가 새 요금제 가입

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

개발자 변경사항 재무 세부정보

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

알림 사용 또는 사용 중지

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

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

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

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

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

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

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

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

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

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

예를 들어 다음은 개발자에게 이용 가능 여부를 알리는 이벤트 템플릿입니다. 다음과 같습니다.

{
    "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를 사용하여 알림 템플릿 보기

GET 요청을 실행하여 /mint/organizations/{org_name}/notification-email-templates/{template_id}, 여기서 {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를 사용하여 알림 템플릿 수정

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

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

예를 들어 다음 요청은 새 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를 사용하여 알림 조건 및 작업 보기

GET 요청을 실행하여 알림 조건 및 작업을 organizations/{org_name}/notification-conditions/{condition_Id}, 각 항목의 의미는 다음과 같습니다. {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를 사용하여 알림 조건 및 작업 수정

POST 요청을 실행하여 알림 조건 및 작업을 organizations/{org_name}/notification-conditions/{condition_Id}, 각 항목의 의미는 다음과 같습니다. {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를 사용하여 알림 조건 및 작업 삭제

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

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 (구성에 유효) 웹훅만 해당)
해당 사항 없음
value

속성의 값입니다.

해당 사항 없음 아니요
associatedCondition

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

해당 사항 없음 아니요

알림 작업의 구성 속성

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

이름 설명 기본값 필수 여부
actionAttribute

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

  • ORG_EMAIL 알림 수신자는 이메일 주소로 식별됩니다.
  • DEV_ID 알림 수신자는 개발자 ID (이메일 주소)로 식별됩니다.
  • COMPANY_ADMINS 회사 전체 관리자에게 알림 전송 첫 번째 레이어가 있습니다. 회사 관리자는 조직 관리자에게 문의하세요.
  • WEBHOOK 알림 수신자 정보가 웹훅으로 전송됨 콜백 핸들러에 전달됩니다. 알림 설정하기 웹훅을 사용하는 방법을 알아보세요.
해당 사항 없음
value

액션 속성의 값입니다.

actionAttributeORG_EMAIL로 설정된 경우 또는 DEV_ID, 값이 ANY이면 적용 가능한 모든 수신자(예: ORG_EMAIL 주소 또는 DEV_ID입니다.

actionAttributeWEBHOOK로 설정된 경우 이 값을 웹훅의 ID입니다.

actionAttributeCOMPANY_ADMINS로 설정하면 이 값은 무시됩니다. 알림이 전송됨 관리자 권한을 부여할 수 있습니다.

해당 사항 없음
templateID

알림 템플릿의 ID입니다.

참고: actionAttribute가 설정된 경우에는 이 옵션을 사용할 수 없습니다. WEBHOOK에게.

해당 사항 없음
postURL

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

참고: actionAttribute가 설정된 경우 이 옵션은 필수입니다. WEBHOOK에게. 값이 ORG_EMAIL, DEV_ID 또는 COMPANY_ADMINS입니다.

해당 사항 없음

알림 템플릿에서 변수 사용

알림 템플릿에서 메시지를 수정할 때 하나 이상의 변수를 포함할 수 있습니다. 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}

사용자의 이름입니다.