您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
事前準備
開始使用 Apigee 機構的營利功能前,您必須先完成下列先決作業:
- 建立 Apigee Edge 帳戶,如「建立 Apigee Edge 帳戶」一節所述。
- 購買營利功能。Edge 一開始不會納入營利 API,也不會將營利功能整合至管理 UI。您必須購買營利功能,才能將營利 API 和營利 UI 元件整合至 Apigee 組織的 Edge。
購買營利功能後,你需要執行下列工作:
- 與 Apigee 設定團隊合作,完成初始的營利設定。請參閱「使用 Apigee 進行初始設定」。
- 設定營利功能。請參閱「設定營利功能」。
- 透過 API 營利。請參閱「透過 API 營利」。
- 建立報表、管理帳戶餘額等,以便管理營利功能。請參閱「管理營利」一文。
使用 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 產品分組。 注意:在 Classic Edge UI 和營利 API 中,產品組合稱為 API 套件。 如要使用 API 管理 API 產品套裝組合,請參閱: |
設定交易錄音政策 | 為每個 API 產品設定交易記錄政策。交易記錄政策會定義您想在 API 產品的交易記錄中擷取的內容,包括任何自訂屬性。 如要使用 API 設定交易記錄政策,請參閱: |
管理及發布費率方案 | 您可以建立費率方案,定義 API 的營利方式。例如,您是否會針對 API 使用量收取固定費率或變動費率。 如要使用 API 管理費率方案,請參閱: |
購買已發布的費率方案 | 使用 API 購買已發布的費率方案,並視需要讓已購買的費率方案到期或取消。 |
在開發人員入口網站中設定營利功能 | 在開發人員入口網站中設定營利功能,讓開發人員可透過自助服務存取費率方案訂閱、自動付款處理和帳單、報表、產品目錄,以及其他營利專屬設定。 |
管理營利設定
設定收益化並將 API 轉換成收益後,您可以執行下表中一或多個步驟:
步驟 | 說明 |
---|---|
管理公司和開發人員 | 管理使用您 API 的公司和開發人員。開發人員是單一實體,可透過電子郵件地址進行唯一識別。公司是指以單一實體管理的開發人員集合。 |
建立報表 | 建立預付餘額、收益和差異報表。如果您是預付型開發人員,可以透過銀行存款來核對預付餘額報表。 |
調整帳單 | 例如,調整帳單以修正記錄中的差異。 |
發出抵免額 | 如有需要,請發出開發人員功勞。對於預付款開發人員而言,抵免額會以使用量減少的形式顯示,並提高開發人員日後的預付款餘額。 對於後付款開發人員,抵免額會在月結單中顯示為獨立的一行,用於減少月結單中的費用。 |
管理預付帳戶餘額 | 查看目前的預付帳戶餘額,並重新加值預付帳戶,或使用第三方付款供應商設定自動加值功能。 |
使用信用額度管理後付款餘額 | 為機構新增支援的貨幣後,您可以為後付款開發人員設定信用額度。信用額度適用於機構中的所有後付款開發人員。 此外,您也可以為個別後付款開發人員設定信用額度。在這種情況下,系統會僅針對指定開發人員,將抵免額限制覆寫為該幣別的任何限制。 |
發出退款 | 針對購買交易向開發人員發出退款。 |
排定營利工作 | 營利功能提供工作排程器和一組預先排定在指定時間執行的工作。使用 API 管理營利作業時間表。 |
查看交易狀態 | 使用 API 查看在指定時間範圍內發生的交易狀態。 |
同步處理 Apigee Edge 資料與營利功能 | 如果 Apigee 指示您這麼做,請重新同步處理營利資料,確保資料同步。您可以同步處理以下項目:機構、API 產品、開發人員和應用程式。 |
刪除機構中的營利資料 | 您可能想刪除機構中的營利資料,以清除測試機構或刪除機構。 |