您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
在 Apigee 中,有幾個概念是常見概念,但具有特殊意義。
字詞 | 定義 |
---|---|
API | 可做為現有 API 外觀的 Proxy。開發人員開始呼叫 Apigee 產生的新 API,而非呼叫現有的 API。此外觀會將您的公開介面與後端 API 分離,讓開發人員不受後端變更影響,同時讓您在邊緣進行創新,而不影響內部開發團隊。在您進行後端變更時,開發人員可以繼續呼叫相同的 API,不會中斷。在更進階的情況下,Apigee 可讓您向同一個 API 公開多個介面,讓您自由自訂 API 簽名,同時滿足各種開發人員的特殊需求。 |
API 基礎路徑和資源 | API 由基礎路徑和一組資源 (又稱為「資源路徑」) 組成。您可以為每個 API 定義單一根網址和多個資源路徑。您可以將 API 想成是一系列 URI,所有 URI 都共用相同的基本路徑。為方便管理 API,Apigee 會在這些原始 URI 中加入顯示名稱和說明。 |
API 使用者 | 與「應用程式開發人員」同義,指的是使用 API 供應商建立的 API 的使用者。 |
API 開發人員 | API 供應商機構中的軟體工程師,負責建構 API。應用程式開發人員 (API 使用者) 會使用這些 API 建構應用程式。 |
API 套件 | 一組 API 產品,會以組合形式向開發人員呈現,通常會與費率方案相關聯。 |
API 產品 | 一組 API 資源 (URI) 與服務方案結合,並以套件形式提供給開發人員。API 產品也可能包含一些專屬於貴商家的中繼資料,用於監控或分析。您可以將一或多個資源納入 API 產品,然後將該產品整合至 API 套件,藉此營利。 |
API 供應商 | API 供應商會使用 Edge 建構 API,供 API 使用者 (應用程式開發人員) 使用。 |
應用程式開發人員 | 在 Edge 中,應用程式開發人員會向 API 供應商註冊應用程式,這也是應用程式開發人員取得呼叫供應商 API Proxy 所需 API 金鑰的方式。 |
應用程式 | 開發人員會透過應用程式存取 API 產品中的資源。建立應用程式時,您會選取要納入的 API 產品,Apigee 就會產生金鑰。每個應用程式都有一個金鑰,可提供對多個 API 產品的存取權。您可以透過應用程式控管誰可以存取您的資源。您可以透過撤銷及重新整理應用程式金鑰,控管哪些人可以存取 API 產品。您也可以透過撤銷或刪除應用程式中產品的存取權,控管資源套件的存取權。 |
餘額詳細資料 | 對於預付型開發人員,則是開發人員帳戶中的餘額。 |
已關閉的調整項 | 已在發布的帳單文件中套用的調整項。 |
已結束的帳單月份 | 已發布帳單文件的完整日曆月。 |
自訂限制 | 您可以使用營利功能明確設定的限制 (例如 API 產品的交易數量限制)。也稱為明確限制。 |
開發人員類別費率方案 | 適用於特定類別中所有開發人員的費率方案,該類別中的所有開發人員均可購買。 |
開發人員費率方案 | 適用於特定開發人員的費率方案,且僅供該開發人員購買。 |
已揭露的代理程式 | 在商業法中,獲准代表他人 (稱為委任人) 行事,與第三方建立法律關係的人士。在營利方面,您可以為共用收益方案設定稅務模型,讓 API 供應商擔任開發人員的公開代理人,代表開發人員收取收益 (可能包括銷售稅)。 |
公開稅務模式 | 稅務模式,其中 API 供應商會擔任開發人員的公開代理人。 |
環境 | API 的執行階段執行作業結構定義。必須先將 API 部署至環境,才能在執行階段存取。根據預設,Apigee 機構會佈建兩個環境:「test」和「prod」。通常會將「test」環境用於部署正在測試的 API。一般而言,您會將「prod」環境用於部署可供實際使用環境使用的 API。 |
混合型稅務模式 | 稅務模式,其中 API 供應商會擔任開發人員的公開代理人。不過,API 供應商會代替開發人員向當地稅務機關支付從訂閱者收取的銷售稅。 |
隱含限制 | 營利功能設定的限制 (例如開發人員的預付款餘額限制)。 |
營利 | Apigee Edge 開發人員服務的元件,可提供簡單易用且彈性的 API 產品營利方式。 |
每月使用金額 | 開發人員在特定月份的總用量,包括設定費 + 交易費 + 週期性費用。 |
每月付款 | 開發人員根據購買的方案支付的週期性付款。費率方案可能會收取重複收費,無論使用量為何,每月都會向開發人員收取費用。 |
對沖陳述式 | 財務文件,顯示月結單和收益分潤報表之間的淨餘額。 |
開啟調整 | 尚未在已發布的帳單文件中套用的調整項。 |
開啟帳單月份 | 尚未發布「最終」帳單文件的完整日曆月份。 |
機構 | 容器可用於存放 Apigee 帳戶中的所有物件,包括 API、API 產品、API 套件、應用程式和開發人員。您必須為每個您可能為成員的機構建立使用者帳戶。(大部分使用者只會在一個機構中擁有帳戶)。您必須在提交的每個 API 要求中,提供您的憑證 (使用者名稱和密碼) 和機構名稱。 |
套件目錄 | API 套件清單。每個套件都會列出其 API 產品和費率方案。 |
預付餘額 | 預付開發人員可預先支付 API 套件費用的金額。 |
預付開發人員 | 預先支付 API 產品使用費的開發人員。使用 API 產品時,系統會從預付開發人員的餘額扣款。開發人員必須維持足夠的預付款餘額,才能購買 API 產品。API 供應商會為開發人員指派預付或後付狀態。 |
政策 | 在 API 流程中,以原子可重複使用的邏輯單元執行的處理步驟。常見的政策包括將要求導向適當的端點、轉換訊息格式、強制執行存取控制、呼叫遠端服務以取得其他資訊、遮蔽外部使用者的敏感資料、檢查訊息內容是否有潛在威脅、快取常見回應以提升效能等等。系統可能會根據要求或回應訊息的內容或背景,有條件地執行政策。舉例來說,如果要求訊息是從智慧型手機傳送,系統可能會執行轉換政策,以自訂回應格式。 |
後付開發人員 | 開發人員使用 API 產品時,會以月結方式 (透過帳單) 支付費用。開發人員會根據帳單中所附方案設定的付款條件,支付 API 產品的使用費用。API 供應商會為開發人員指派後付或預付狀態。 |
價格點 | 產品可能在市場上販售的價格範圍。 |
價目表費率方案 | 費率方案,針對涉及營利 API 產品的每筆交易,向開發人員收取固定或浮動費率。 |
房價方案 | 在已營利的 API 套件中提供 API 產品時,收取的費用、其他費用和收益分潤的規格。 |
resource path |
資源路徑是 RESTful 概念,是一種統一資源 ID (URI),用於識別特定資源的網路路徑。 |
收益分潤費率方案 | 費率方案,其中涉及營利 API 產品的每筆交易產生收益的百分比,會與發出要求的應用程式開發人員共享。 |
收益分潤和費率方案 | 費率方案:在每筆涉及營利 API 產品的交易中,收益的百分比會與發出要求的應用程式開發人員共用。每筆交易也會向開發人員收取固定或變動費用。 |
自付式月費帳單 | 系統產生的財務文件,而非收益分潤報表。這份報表會詳細列出開發人員應收的金額,並代表開發人員向 API 供應商開立帳單。 |
標準費率方案 | 所有開發人員都能購買的費率方案。 |
tax | 開發人員的用量和費用所需支付的總稅金。 |
儲值 | 預付型開發人員為預付款餘額增資所採取的行動。 |
交易記錄政策 | 一種機制,可讓營利功能擷取交易參數和自訂屬性。營利功能需要這項資訊才能執行營利處理作業,例如根據每次交易中擷取的自訂屬性,將費率方案套用至 API 要求和回應。 |
未公開的代理程式 | 參與應用程式底層供應作業的機構 (或作業者),因此視為代表開發人員購買內容 (僅限稅務用途)。機構 (或經營者) 可擔任未公開的代理人,向使用者收取並記錄應繳稅款。這項狀態僅與稅務相關,不會影響開發人員在供應鏈中的法律地位。 |
未揭露的稅務模式 | 稅金模式,API 供應商會從使用者身上收取稅金,並將稅金支付給當地稅務機關。 |
版本 | 面向開發人員的 API 介面版本。例如 pivotaltracker.com/services/v3 或 api.enterprise.apigee.com/v1。(這個詞與「修訂版本」不同,後者是指將設定和政策封裝到 API Proxy 中的編號版本控制套件。簡而言之,API 介面有版本,而 API Proxy 則有修訂版本。 |