本頁面由 Cloud Translation API 翻譯而成。

使用通知範本設定通知

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。資訊

什麼是通知範本？

營利服務提供了一組範本，用於定義各種事件通知的範例文字。您可自訂以下任一範本，以執行下列操作：

通知所有開發人員，例如新產品、條款及細則的新版本或新費率方案。
通知受影響的開發人員，例如價格調整方案異動。
通知 API 供應商，說明開發人員相關事件，例如開發人員註冊帳戶，或開發人員註冊費率方案時。
將特定事件告知所有公司管理員。

或者，您也可以建立定義 HTTP 回呼處理常式的 Webhook，然後設定觸發 Webhook 的條件，如「使用 Webhook 設定通知」一節所述。

探索「通知」頁面

按照下方說明存取「通知」頁面。

邊緣

如何使用 Edge UI 存取「通知」頁面：

登入 apigee.com/edge。
在左側導覽列中，依序選取「發布」>「營利」>「通知」。

系統隨即會顯示「通知」頁面。

如圖中所示，「通知」頁面可讓您：

展開及收合通知詳細資料
編輯通知詳細資料並儲存所有編輯內容
啟用或停用通知

傳統邊緣 (Private Cloud)

如何使用傳統版 Edge UI 存取「通知」頁面：

登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
在頂端導覽列中，依序選取「管理」>「通知」。

您可以在「通知」頁面上進行下列操作：

啟用或停用通知
編輯通知詳細資料並儲存所有編輯內容

編輯通知

如何透過 UI 編輯通知：

前往「通知」頁面。
找到要編輯的通知，按一下旁邊的，即可展開詳細資料。
視需要編輯「主旨」、「內文」和「收件者 (如有)」欄位。
如要瞭解可在通知範本中指定的變數，請參閱在通知範本中使用變數。

請參閱以下章節，進一步瞭解如何編輯各類別的通知：
勾選通知旁的核取方塊即可啟用通知。
重複步驟 2 到 4，編輯其他通知。
按一下「儲存」即可儲存所有變更。

系統會顯示訊息，確認通知已儲存。儲存作業可能需要幾分鐘才能完成。

編輯通知以通知所有開發人員

所有開發人員都會收到您在「通知所有開發人員」區段中所選的事件類型通知。

通知排定在當天結束時執行。通知送出後，系統會自動清除事件核取方塊。您必須再次選取這些聯絡人，才能排定相關聯事件類型的通知。

下表根據「通知所有開發人員」部分中的事件類型列出通知。詳情請參閱「使用 UI 編輯通知」。

事件類型	觸發條件	附註
新增整批交易廣告	已推出新的 API 套件	在更新時，將每個新套件 (以及每個套件內含的產品) 的名稱新增至電子郵件範本的內文。您也可以新增開發人員入口網站的連結或任何其他網站，提供更多關於通知的資訊。
新產品	已推出新的 API 產品	在更新時，將每項新產品的名稱新增至電子郵件範本的內文。您也可以新增開發人員入口網站的連結或任何其他網站，提供更多關於通知的資訊。
新市場/涵蓋率	我們針對特定地理區域市場推出新的 API 產品	隨著更新，請在電子郵件範本的內文中新增每個新市場和相關產品的名稱。您也可以新增開發人員入口網站的連結或任何其他網站，提供更多關於通知的資訊。

編輯通知來通知受影響的開發人員

您在「通知受影響的開發人員」部分中選取事件類型時，系統只會將通知傳送給受到這些事件類型影響的開發人員。舉例來說，如果選取「修改費率方案」活動，則系統只會向已接受房價方案的開發人員傳送通知。

下表根據「通知受影響的開發人員」一節中的事件類型列出相關通知。詳情請參閱「使用 UI 編輯通知」。

事件類型	觸發條件	附註
條款及細則未獲核准或已過期	已發布一組新的條款及細則，開發人員尚未接受這些條款及細則	系統會在新的《條款及細則》生效前 30 天、7 天和 1 天傳送通知。
新增房價方案	已發布新的房價方案	如果房價方案為：標準方案，所有開發人員都會收到通知。開發人員類別費率方案，系統只會通知該類別的開發人員。開發人員費率方案，只會通知特定開發人員。
修改費率方案	已推出較新版本的房價方案	只有購買目前版本的開發人員會收到通知。這則通知可讓開發人員審查新版本，如果他們不想接受新的費率方案，則可終止或切換方案。
已過期費率方案	房價方案已過期，沒有後續追蹤費率方案	您首次將費率方案設為到期時，系統就會傳送這則通知，並在到期日前 30 天、7 天和 1 天傳送額外通知。系統只會通知已購買費率方案的開發人員到期。
續約費率方案	已續訂房價方案。	告知開發人員會收取適用費用。
超過頻率限制	已超過房價方案限制	告知開發人員會收取適用費用。
免費增值費率方案用盡	已用盡免費用量期間 (依交易次數或天數計算)	免費用量期限取決於免費增值費率方案。
已發布帳單文件	我們已提供開發人員的帳單文件 (例如應付憑據)。
開發人員註冊新的費率方案	開發人員註冊新的費率方案。

編輯通知 API 供應商

針對您在「Notify API Provider」(通知 API 供應商) 區段中選取的事件類型，系統會將通知傳送到您指定的 API 供應商。

下表根據「Notification API Provider」(通知 API 供應商) 部分中的事件類型列出通知。詳情請參閱「使用 UI 編輯通知」。

事件類型	觸發條件
新開發人員註冊	開發人員已註冊帳戶。
開發人員新增應用程式	開發人員已建立新的應用程式。
開發人員註冊訂閱新的費率方案	開發人員已申請費率方案。
開發人員變更財務詳細資料	開發人員變更了財務詳細資料，例如公司名稱或公司地址。

啟用或停用通知

如何透過使用者介面啟用或停用通知：

前往「通知」頁面。
分別選取或取消選取通知旁邊的核取方塊，以啟用或停用通知。
按一下「儲存」即可儲存所有變更。

儲存作業可能需要幾分鐘才能完成。系統會顯示訊息，確認通知已儲存。

使用 API 使用範本設定通知

請按照下列各節所述，使用 API 設定通知。

使用 API 管理通知範本

請按照下列各節說明，使用 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 建立通知條件和動作
使用 API 檢視通知條件和動作
使用 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` (僅適用於設定 Webhook)	不適用	是
`value`	屬性的值。	不適用	否
`associatedCondition`	相關條件的參照。	不適用	否

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 (僅適用於設定 Webhook)

不適用

是

value

屬性的值。

不適用

否

associatedCondition

相關條件的參照。

不適用

否

通知動作的設定屬性

使用 API 時，通知動作可以使用下列設定屬性。

名稱	說明	預設	必填與否
`actionAttribute`	識別通知收件者的方法。這個值可以是下列一或多項： `ORG_EMAIL`。系統是根據電子郵件地址區分通知收件者。 `DEV_ID`。通知收件者是由開發人員 ID (電子郵件地址) 識別。 `COMPANY_ADMINS`。無論設定的值為何，系統會將通知傳送給所有公司管理員。請注意，公司管理員與機構管理員不同。 `WEBHOOK`。通知收件者資訊會傳送至 Webhook 回呼處理常式。詳情請參閱「使用 Webhook 設定通知」。	不適用	是
`value`	動作屬性的值。如果 `actionAttribute` 設為 `ORG_EMAIL` 或 `DEV_ID`，則 `ANY` 值會將通知傳送給任何適用的收件者，例如任何 `ORG_EMAIL` 地址或任何 `DEV_ID`。如果將 `actionAttribute` 設為 `WEBHOOK`，請將這個值設為 Webhook 的 ID，如果將 `actionAttribute` 設為 `COMPANY_ADMINS`，系統會忽略這個值，並傳送通知給所有公司管理員。	不適用	是
`templateID`	通知範本的 ID。注意：如果將 `actionAttribute` 設為 `WEBHOOK`，則這個選項無效。	不適用	是
`postURL`	Webhook 的回呼處理常式。注意：如果將 `actionAttribute` 設為 `WEBHOOK`，就必須使用這個選項。如果值設為 `ORG_EMAIL`、`DEV_ID` 或 `COMPANY_ADMINS`，則這個選項無效。	不適用	是

在通知範本中使用變數

在通知範本中編輯訊息時，可以加入一或多個變數，使用彈簧運算語言 (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 支援團隊聯絡。