使用通知範本設定通知

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

什麼是通知範本？

營利工具提供一組範本，用來定義各種事件類型的範例文字 通知。您可以自訂任何範本來執行以下操作：

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

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

探索「通知」頁面

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

邊緣

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

  1. 登入 apigee.com/edge。
  2. 選取「發布」>「發布」營利 >通知。

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

如圖中重點說明，您可以透過「通知」頁面執行下列操作：

傳統版 Edge (Private Cloud)

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

  1. 登入「http://ms-ip:9000」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。

  2. 依序選取「管理員」>通知。

「通知」頁面可讓您：

編輯通知

如何使用 UI 編輯通知：

  1. 前往通知頁面。
  2. 按一下要編輯的通知旁邊的 ，展開詳細資料。
  3. 視需要編輯 [主旨]、[內文] 和 [收件者 (如果有的話)] 欄位。

    如要進一步瞭解可在通知範本中指定的變數，請參閱在通知範本中使用變數。

    如要進一步瞭解如何編輯每個類別中的通知，請參閱以下各節：

  4. 勾選通知旁的核取方塊，即可啟用通知。
  5. 重複步驟 2 到 4，即可編輯其他通知。
  6. 按一下「儲存」即可儲存所有變更。

系統會顯示一則訊息，確認通知 已儲存。儲存作業會在幾分鐘內完成。

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

針對您在「通知所有開發人員」中選取的事件類型接收通知 傳送給所有開發人員

通知已排定在當天結束執行。收到通知後 活動核取方塊就會自動清除。必須再次選取，才能安排時間 接收相關事件類型的通知。

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

事件類型 觸發條件 附註
新增套件 有新的 API 套件可用

將每個新套件的名稱 (以及每個套件內含的產品) 新增至 請附上電子郵件範本的內文您也可以在 開發人員入口網站，或是其他提供 通知。
新產品 有新的 API 產品可供使用

在電子郵件範本內文中，加入每項新產品的名稱 更新。您亦可新增開發人員入口網站的連結 提供了通知的詳細資訊。
新市場/涵蓋範圍 全新 API 產品僅在特定地理區域推出

在電子郵件內文中加入新市場和相關產品的名稱 更新範本您也可以在開發人員入口網站 提供這則通知相關詳細資訊的其他網站。

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

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

下表列出「通知受影響的開發人員」部分，系統會根據事件類型列出通知。 詳情請參閱「使用 UI 編輯通知」。

事件類型 觸發條件 附註
未接受或已過期的條款及細則 已發布新的條款及細則組合，但開發人員尚未接受

系統會在新條款及細則截止的 30 天、7 天和前 1 天傳送通知 就能派上用場
新增房價方案 已發布新的房價方案

如果費率方案為：

  • 如為標準方案，所有開發人員都會收到通知。
  • 開發人員類別費率方案，只有該類別的開發人員會收到通知。
  • 開發人員費率方案只會通知特定開發人員。
修訂費率方案 已購買的費率方案已推出較新版本

只有購買目前版本的開發人員會收到通知。 通知可讓開發人員審查新版本，並且終止或切換 方案。
費率方案已過期 費率方案已過期，沒有後續追蹤費率方案

這則通知會在你最初將費率方案設為到期時傳送， 在到期日前 30、7 天和 1 天傳送額外的通知。僅限那些 針對購買費率方案到期，而購買費率方案的開發人員，他們會收到通知。
續約費率方案 已續訂費率方案。

告知開發人員我們會收取相關費用。
超過頻率限制 已超過費率方案上限

告知開發人員我們會收取相關費用。
免費增值費率方案終止 已超過免費用量期間 (依交易次數或天數計算)

免費用量期間取決於您的免費增值費率方案。
已發布帳單文件

我們會提供開發人員的帳單文件 (例如月結單)。
開發人員訂閱新的費率方案 開發人員訂閱新的費率方案，

編輯 Notify API 供應商的通知

針對在 Notify API Provider 中選取的事件類型通知 部分都會傳送到您指定的 API 供應商

下表列出在「Notify API 供應商」部分中的事件類型通知。 詳情請參閱「使用 UI 編輯通知」。

事件類型 觸發條件
新開發人員註冊

開發人員已註冊帳戶。
開發人員新增應用程式

開發人員已建立新的應用程式。
開發人員註冊新的費率方案

開發人員已訂閱房價方案。
開發人員變更財務詳細資料

開發人員已變更財務詳細資料，例如公司名稱或公司 讓我們看看 DNS 解析 進一步探索內部和外部位址

啟用或停用通知

如要透過 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

舉例來說，以下是向開發人員通知開發人員供應情形的活動範本 全新 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 查看通知範本

向以下應用程式發出 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 (適用於設定 僅限 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) 來表示 Transaction 中傳回的值 物件。

下表摘要說明最常用的通知範本變數。

變數 說明
${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}

使用者的名稱。