Google 會運用 AI 技術將內容翻譯成你偏好的語言，但可能會出錯。

使用通知範本設定通知

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

什麼是通知範本？

營利功能提供一組範本，定義各種事件通知的範例文字。你可以自訂任何範本，以便：

將新產品、新版條款及細則或新費率方案等活動通知所有開發人員。
通知受影響的開發人員相關事件，例如修訂費率方案。
通知 API 供應商開發人員相關事件，例如開發人員註冊帳戶或申請費率方案時。
通知所有公司管理員特定事件。

或者，您也可以建立定義 HTTP 回呼處理常式的 Webhook，然後設定觸發 Webhook 的條件，詳情請參閱「使用 Webhook 設定通知」。

瀏覽「通知」頁面

存取「通知」頁面，詳情請見下文。

Edge

如要使用 Edge 使用者介面存取「通知」頁面，請按照下列步驟操作：

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

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

如圖所示，「通知」頁面可讓您執行下列操作：

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

Classic 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 供應商。

下表列出 Notify API Provider 區段中，根據事件類型發送的通知。詳情請參閱「使用 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)	N/A	是
`value`	屬性的值。	N/A	否
`associatedCondition`	參照相關聯的條件。	N/A	否

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)

N/A

是

value

屬性的值。

N/A

否

associatedCondition

參照相關聯的條件。

N/A

否

通知動作的設定屬性

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

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

在通知範本中使用變數

在通知範本中編輯訊息時，您可以使用 Spring 運算式語言 (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 支援團隊聯絡。