設定營利功能的步驟

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

事前準備

開始透過 Apigee 機構使用營利功能之前，您必須先執行下列前置工作：

  • 按照建立 Apigee Edge 帳戶的說明，建立 Apigee Edge 帳戶。
  • 購買營利。Edge 一開始不含營利 API，也不會將營利機制整合至管理 UI。您必須購買營利功能，才能將營利 API 和營利 UI 元件整合至 Apigee 機構的 Edge。

購買營利功能後，您必須執行下列工作：

使用 Apigee 進行初始設定

與 Apigee Edge 設定團隊合作，完成營利的初始設定。根據您的輸入內容，設定團隊會建立下列項目：

  • 貴機構是否為電信公司。
  • 您希望購買費率方案的開發人員支援哪種計費方式：預付、後付或兩者皆是。請參閱預付與後付帳戶。
  • 查看從營利中擷取的資料詳細或摘要資訊，並匯出至您的帳戶系統，以及所需的資料格式。
  • 自訂電子郵件回覆地址。針對傳送給公司和開發人員的營利電子郵件通知，系統會設定預設的 noreply@apigee.com 地址。您必須為貴機構申請自訂回覆名稱和地址。

Apigee 設定團隊會執行指令碼，將營利情形與貴機構及您透過 Apigee Edge 建立的任何開發人員、應用程式和 API 產品保持同步。Apigee 支援可能會要求您日後同步處理機構，詳情請參閱「使用營利服務同步處理 Apigee Edge 資料」一文。除非 Apigee 指示，否則請勿同步處理營利資料。

設定營利方式

下表摘要列出為 Apigee 機構設定營利功能的必要步驟。
步驟 說明
編輯機構資料 在營利初始設定過程中，Apigee Edge 設定團隊會為您設定機構資料。

您必須視情況編輯機構資料，才能新增或更新機構相關資訊。舉例來說，您可能需要更新帳單類型、貨幣設定或稅金模式。
管理支援的貨幣 進行營利初始設定的過程中，Apigee Edge 設定團隊會指定貴機構支援的貨幣，並設定預設貨幣。

您可以擷取貴機構支援的貨幣，並新增或刪除支援的貨幣 (反映開發人員或費率方案使用的貨幣)。

注意：營利功能會自動執行每日工作，針對每種支援貨幣提供美元的匯率。根據預設，工作會每天在午夜過後 1 秒執行。詳情請參閱「安排營利工作」。
指定條款及細則 您也可以選擇在發布費率方案前，在貴機構的資料中新增條款及細則。發布費率方案後，開發人員入口網站會顯示現行版本的條款及細則。

注意：條款及細則不在貴機構的資料中。在機構設定檔中，您可以指定條款及細則的所在位置 (公開網址)，您可以加入多個版本的條款及細則，以反映一段時間內的變更。
強制執行營利限制 將 MonetizeLimitsCheck 政策附加至 API Proxy，藉此強制執行營利限制。

具體來說，系統會在下列情況下觸發這項政策：

  • 開發人員存取營利 API 的開發人員尚未註冊或尚未訂閱費率方案。
  • 開發人員已超出訂閱費率方案的交易量。
  • 開發人員預付帳戶餘額或後付信用額度已達到上限。
設定通知 設定通知以通知開發人員或 API 供應商有特定事件 (例如新發布的費率方案)。

透過 API 營利

當您透過 API 營利時，必須將一或多項 API 產品組合到一個 API 產品組合中，並定義相關的費率方案。

您必須發布套件的費率方案 (開始日期為當天或未來的日期)，開發人員才會看到 API 產品套裝組合。開發人員可以藉由購買現行的其中一個費率方案，註冊應用程式只能使用 API 產品套裝組合。如果 API 產品套裝組合沒有目前使用的已發布費率方案，則套件未啟用營利功能。

下表摘要說明透過 API 營利所需的步驟。

步驟 說明
管理 API 產品套裝組合

建立 API 產品套裝組合，將 API 產品分組。

注意：在傳統版 Edge UI 和營利 API 中，產品套裝組合則稱為 API 套件。

如要使用 API 管理 API 產品套裝組合，請參閱：
設定交易記錄政策

為各個 API 產品設定交易記錄政策。交易記錄政策會定義您要在 API 產品的交易記錄中擷取的內容，包括任何自訂屬性。

如要使用 API 設定交易記錄政策，請參閱：
管理及發布房價方案

建立費率方案，定義 API 的營利方法。例如：以固定費率或變動費率收取 API 使用費。

如要使用 API 管理房價方案，請參閱：
購買已發布的房價方案 購買已發布的費率方案，並視需要使用 API 到期或取消購買的費率方案。
在開發人員入口網站設定營利功能 在開發人員入口網站設定營利功能，讓開發人員自助存取費率方案、自動付款與帳單、報表、產品目錄，以及其他營利專用設定。

管理營利設定

設定營利功能並透過 API 營利後，您可以執行下表摘要的一或多項步驟：

步驟 說明
管理公司和開發人員 管理使用您 API 的公司和開發人員。開發人員是單一實體，且能夠透過電子郵件地址明確識別。公司是指將開發人員視為單一實體管理的一組開發人員。
製作報表 建立預付餘額、收益和變異數報表。如果是已預付郵資的開發人員，您可以核對預付餘額報告和銀行存款。
調整帳單 例如調整帳單來修正記錄中不一致的問題。
核發抵免額 視需要核發開發人員抵免額。如果是預付型開發人員，款項中出現的減少幅度是讓開發人員的預付餘額增加。 如果是後付開發人員，抵免額會在月結單中單獨列為一行，以降低月結單費用。
管理預付帳戶餘額 查看目前的預付帳戶餘額，並重新載入預付帳戶，或透過第三方付款服務供應商設定自動重新載入。
運用信用額度管理後付餘額 為機構新增支援的貨幣後，您可以為後付的開發人員設定信用額度。信用額度適用於機構中所有的後付開發人員。 此外，您也可以為個別後付開發人員設定信用額度。在這種情況下，抵免額上限會覆寫指定開發人員為貨幣設定的任何上限。
退款後 針對購買交易給予開發人員退款。
安排營利工作 營利服務會提供工作排程器，以及一組預先排定在指定時間執行的工作。使用 API 管理營利工作時間表。
查看交易狀態 使用 API 查看指定時間範圍內發生的交易狀態。
透過營利機制同步處理 Apigee Edge 資料 根據 Apigee 的指示，重新將資料與營利服務同步處理，確保資料同步。 您可以同步處理下列項目：機構、API 產品、開發人員與應用程式。
刪除貴機構的營利資料 建議您刪除貴機構的營利資料，以便清除測試機構或刪除機構。