在 Edge 中啟用營利功能

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

如以下各節所述,使用 UImonetization API 啟用營利功能。

透過使用者介面取得營利資格

下文說明如何運用營利功能。

Edge

如何透過 Edge UI 使用營利功能:

  1. 登入 https://apigee.com/edge
  2. 切換為已啟用營利功能的機構。
  3. 在「發布」>「營利」下方,存取下表所述的營利功能。
    營利功能 說明
    公司 將開發人員編入不同的公司,
    抵免額 開發人員核發抵免額。
    開發人員類別 將具有類似特性的開發人員或公司分到一組。
    通知 使用通知範本和 Webhook 設定通知。
    機構付款資料 執行下列工作:
    產品組合 建立 API 產品套裝組合 - 封裝 API 產品
    費率方案 建立及發布費率方案,讓開發人員購買方案來使用您的 API
    報表 建立報表,以便瞭解帳單、預付餘額、收益或變異數
    Webhook 使用 Webhook 設定通知

傳統邊緣 (Private Cloud)

如何透過傳統版 Edge UI 使用營利功能:

  1. 登入 http://ms-ip:9000,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 切換至已啟用營利功能的機構。
  3. 如何使用下表說明的營利功能。
  4. 營利選單 說明
    管理 > 通知 使用通知範本設定通知
    管理員 > 機構設定檔 執行下列工作:
    [管理員] > [Webhook] 使用 Webhook 設定通知
    營利 > 調整項 調整流量詳細資料
    營利 > 抵免額 核發抵免額給開發人員
    營利 > 退款 向開發人員張貼購買交易的退款
    營利 > 營利報表 建立報表,以便瞭解帳單、預付餘額、收益或變異數
    發布 > 公司 將開發人員歸入公司
    「發布」>「套件」 建立 API 套件來封裝 API 產品
    「發布」>「產品」 為您要用來營利的每個 API 產品建立交易記錄政策

使用 API 存取營利資料

營利 API 的基本路徑為 https://api.enterprise.apigee.com/v1/mint。所有營利要求的網址都會以營利基礎路徑開頭,後面接有目標資源的路徑。

如需營利 API 的完整清單,請參閱 Monetize API

請參考以下範例:

curl -H "Content-Type: application/json" -X POST -d \
'{
 "url":"www.testoperator/termsandconditions",
 "tncText":"Sample text for the T&C",
 "version":"1.1",
 "startDate":"2013-06-24”
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-u email:password

在整份說明文件中,我們都以 cURL 提供營利 API 的範例。您可以將範例指令複製並貼到指令列終端機中。複製指令並貼到終端機之後,您必須將指令中的變數替換為 Apigee Edge 帳戶資訊。舉例來說,在上述範例中,您需要替換下列變數:

  • {org_name}:貴機構的名稱。
  • email:您的 Apigee Edge 帳戶電子郵件地址。
  • password:您的 Apigee Edge 帳戶密碼。