您目前查看的是 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 供應商 | 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 產品時,需支付的費用、其他費用和收益分潤比例。 |
| resource path |
資源路徑是符合 REST 樣式的概念,也是統一資源 ID (URI),可識別特定資源的網路路徑。 |
| 收益分潤費率方案 | 費率方案:針對涉及營利 API 產品的每筆交易,將產生的收益按百分比分配給發出要求的應用程式開發人員。 |
| 收益分潤和價目表方案 | 費率方案:針對涉及營利 API 產品的每筆交易,將產生的收益按百分比分配給發出要求的應用程式開發人員。此外,開發人員也須為每筆交易支付固定或浮動費用。 |
| 自結月結單 | 系統會產生財務文件,而非收益分潤對帳單。其中詳列應付給開發人員的金額,並代表開發人員向 API 供應商開立應付憑據。 |
| 標準費率方案 | 所有開發人員都能購買的費率方案。 |
| 稅 | 開發人員使用量和費用適用的稅金總額。 |
| 加值 | 預付型開發人員將資金加入預付餘額的動作。 |
| 交易記錄政策 | 這項機制可讓營利功能擷取交易參數和自訂屬性。營利功能需要這項資訊才能執行營利處理作業,例如根據每筆交易擷取的自訂屬性,將費率方案套用至 API 要求和回應。 |
| 未公開代理 | 參與應用程式基礎供應鏈的機構 (或營運商),可視為代表開發人員購買內容 (僅限稅務用途)。做為未揭露的代理人,機構 (或營運商) 可以向使用者收取應付稅金並結算。這項狀態僅適用於稅務用途,不會影響供應鏈中開發人員的法律狀態。 |
| 未公開的稅務模式 | API 供應商會從向使用者收取的稅金中扣除稅額,並支付給當地稅務機關。 |
| 版本 | 面向開發人員的 API 介面版本。例如 pivotaltracker.com/services/v3 或 api.enterprise.apigee.com/v1。(這個詞彙與「修訂版本」不同,後者是指 API Proxy 中綁定的設定和政策,並以編號控管版本。簡而言之,API 介面有版本,而 API Proxy 則有修訂版本。 |