詞彙解釋

您目前查看的是 Apigee Edge 說明文件。
參閱 Apigee X 說明文件
資訊

其中幾個概念,都是在 Apigee 中具有獨特意義的常見概念。

字詞 定義
API 可做為現有 API 門面的 Proxy。開發人員不會呼叫現有的 API,而是開始呼叫 Apigee 產生的新 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 供應商建構 API (使用 Edge),供 API 消費者 (應用程式開發人員) 使用。
應用程式開發人員 在 Edge 中,應用程式開發人員會向 API 供應商註冊應用程式,也就是應用程式開發人員取得呼叫供應商 API Proxy 所需的 API 金鑰的方式。
應用程式 您的開發人員可透過應用程式存取 API 產品中的資源。建立應用程式時,您須選取要納入的 API 產品,Apigee 就會產生金鑰。每個應用程式都有一組金鑰,讓使用者存取多項 API 產品。應用程式可讓您控管哪些人員能存取您的資源。您可以撤銷及重新整理應用程式金鑰,藉此控管有權存取 API 產品的使用者。您也可以撤銷或刪除應用程式中產品的存取權,藉此控管資源組合的存取權。
餘額詳情 如果是預付型開發人員,請在開發人員帳戶的餘額。
關閉的調整幅度 已在發布的帳單文件中套用的調整項。
已關閉帳單月份 已發布帳單文件的完整月份。
自訂限制 使用營利功能明確設定的限制 (例如 API 產品的交易次數限制)。也稱為明確限制。
開發人員類別費率方案 費率方案適用於特定類別的所有開發人員,且該類別中的所有開發人員可購買此方案。
開發人員費率方案 特定開發人員適用的費率方案,僅供該開發人員購買。
遭揭露的服務專員 在商業法律中,經授權可代表另一方 (稱為主體) 與第三方建立法律關係的使用者。在營利過程中,您可以為共用收益方案設定稅務模式,讓 API 供應商擔任揭露的開發代理人,代表開發人員收取收益 (可能須繳納銷售稅)。
公開的稅務模式 API 供應商擔任開發人員揭露服務專員的稅務模式。
環境 API 的執行階段執行環境。API 必須先部署至環境,才能在執行階段存取。根據預設,Apigee 機構會佈建「test」和「prod」兩個環境。「測試」環境通常用於部署正在測試的 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 產品使用費用、其他費用和收益分潤規範。
資源
路徑
符合 REST 樣式的概念,「資源路徑」是用來識別特定資源網路路徑的統一資源 (URI)。
收益分潤費率方案 費率方案中,每筆與營利 API 產品相關的交易產生的收益比例,都會與發出要求的應用程式開發人員分享。
收益分潤和價目表方案 費率方案中,每筆與營利 API 產品相關的交易產生的收益比例,都會與發出要求的應用程式開發人員分享。每筆交易的開發人員也會收取固定或變動的費用。
自行帳單月結單 產生的財務文件,而非收益分潤對帳單。這類款項會詳細列出開發人員的應付金額,並代表開發人員開立應付憑據給 API 供應商。
標準費率方案 所有開發人員可購買的費率方案。
tax 開發人員使用和相關費用所適用的總稅金。
儲值 預付型開發人員為了預付餘額而執行的動作。
交易記錄政策 可讓營利功能擷取交易參數和自訂屬性的機制。營利服務需要這項資訊才能執行營利程序,例如根據每筆交易擷取的自訂屬性,將費率方案套用至 API 要求和回應。
未公開的服務專員 參與應用程式基礎供應的組織 (或營運商),因此視為代表開發人員購買內容 (僅用於稅務用途)。機構 (或營運商) 的身分為未公開的服務專員,可收取使用者應繳納的稅金,並代為計算。這個狀態僅適用於稅務用途,開發人員在供應鏈中的法定狀態不會受到影響。
未公開的稅務模式 一種稅務模式,可讓 API 供應商從向使用者收取的稅金中扣除退稅,並支付給當地稅務機關。
版本 供開發人員使用的 API 介面版本。例如,Pivotaltracker.com/services/v3 或 api.enterprise.apigee.com/v1。(這個詞彙和「修訂版本」不同,修訂版本是隨附於 API Proxy 中,並由版本管控的設定套件和政策。簡單來說,API 介面有版本,API Proxy 則具備修訂版本。