設定營利功能的步驟

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

事前準備

開始透過 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 秒執行。詳情請參閱「安排營利工作」。

指定條款及細則 發布費率方案前,您可以選擇在機構設定檔中新增條款及細則。發布費率方案後,開發人員入口網站會顯示條款及細則的目前版本。

注意:條款及細則位於機構簡介之外。在機構設定檔中,指定條款及細則的位置 (公開網址)。您可以新增多個版本的條款,反映條款隨時間的變更。

強制執行營利限制 將 MonetizationLimitsCheck 政策附加至 API Proxy,強制執行營利限制。

具體來說,在下列情況下會觸發這項政策:

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

透過 API 營利

如果想透過 API 營利,請將一或多個 API 產品組合成 API 產品組合,並定義相關聯的費率方案。

您必須為套件發布費率方案 (開始日期為當天或未來日期),開發人員才會看到 API 產品組合。開發人員必須購買目前有效的費率方案,才能註冊應用程式以使用 API 產品組合。如果 API 產品組合沒有目前生效的已發布費率方案,該套件就無法營利。

下表彙整了 API 營利所需的步驟。

步驟 說明
管理 API 產品組合

建立 API 產品組合,將 API 產品分組。

注意:在 Classic Edge 使用者介面和營利 API 中,產品組合稱為 API 套件。

如要使用 API 管理 API 產品組合,請參閱:

設定交易記錄政策

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

如要使用 API 設定交易記錄政策,請參閱:

管理及發布費率方案

制定費率方案,定義 API 的營利方式。例如,您是否會針對 API 使用收取固定或變動費率。

如要使用 API 管理費率方案,請參閱:

購買已發布的費率方案 使用 API 購買已發布的費率方案,並視需要取消或讓已購買的費率方案到期。
在開發人員入口網站中設定營利 在開發人員入口網站中設定營利功能,讓開發人員自助式存取費率方案訂閱、自動付款處理和帳單、報表、產品目錄,以及其他營利專屬設定。

管理營利設定

設定營利並透過 API 營利後,您可以執行下表列出的步驟:

步驟 說明
管理公司和開發人員 管理使用您 API 的公司和開發人員。開發人員是單一實體,以電子郵件地址做為專屬識別碼。公司是指以單一實體管理的一組開發人員。
製作報表 建立預付餘額、收益和差異報表。預付型開發人員可以根據預付餘額報表,與銀行存款進行對帳。
進行帳單調整 例如,調整帳單以修正記錄中的差異。
核發抵免額 視需要發放開發人員抵免額。對於預付型開發人員,抵免額會顯示為用量減少,進而增加開發人員日後的預付餘額。 如果是後付型開發人員,抵免額會顯示在月結單的獨立一行,減少月結單中的費用。
管理預付帳戶餘額 查看目前的預付帳戶餘額,以及透過第三方付款服務供應商設定自動加值,為預付帳戶加值。
使用信用額度管理後付餘額 為機構新增支援的幣別後,即可為後付開發人員設定信用額度。信用額度適用於機構中的所有後付開發人員。 此外,您也可以為個別後付開發人員設定信用額度上限。在此情況下,信用額度會覆寫指定開發人員的幣別限制。
退款 針對購買交易向開發人員退款。
排定營利工作 營利功能提供工作排程器和一組預先排定的工作,會在指定時間執行。使用 API 管理營利作業排程。
查看交易狀態 使用 API 查看指定時間範圍內的交易狀態。
將 Apigee Edge 資料與營利功能同步 如果 Apigee 指示您這麼做,請重新同步處理資料與營利功能,確保資料同步。 您可以同步處理下列項目:機構、API 產品、開發人員和應用程式。
刪除機構的營利資料 您可能想刪除機構的營利資料,以便清除測試機構或刪除機構。