瞭解機構

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

機構是 Apigee Edge 中的頂層容器，其中包含所有 API Proxy 和相關資源。本主題的其餘部分會深入探討機構，以下是幾個實用重點：

  • 根據預設，呼叫 API Proxy 時使用的網址會包含機構名稱，如「關於虛擬主機」一文所述。例如： 
    http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
  • Edge 管理 UI 的網址中會顯示機構名稱。舉例來說，下列網址會顯示 docs 機構的 API 代理項目：

    在網址 apigee.com/organizations/docs/proxies 中，/docs/ 以圓圈標示。

  • 您可能只建立了一個機構，但可以以具備特定權限的使用者或管理員身分，加入其他機構。在 Edge 管理 UI 中，如果您屬於多個機構，可以切換至其他機構，詳情請參閱「在機構之間切換」。

  • 以機構管理員角色透過管理 API 進行呼叫時，機構是大多數呼叫路徑的必要部分。舉例來說，下列管理 API cURL 要求會傳回機構中的所有 API Proxy 清單：
    curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address

影片：觀看短片，瞭解機構如何支援 API 管理的多租戶架構。

機構元件

建立 Edge 帳戶時，Edge 會自動為您建立機構。建立完成後，您就可以將使用者新增至機構、建立 API Proxy 和 API 產品，以及註冊開發人員和應用程式。

下圖顯示 Edge 組織模型的主要元件。這個模型定義了 API、API 產品、應用程式和應用程式開發人員在 Edge 中的關聯。

流程圖：顯示環境、使用者、API 產品和開發人員與應用程式、API 金鑰/OAuth 權杖和 API Proxy 的關係。

這個模型不會顯示 Apigee Edge 的所有功能。如果您使用營利功能，模型就會有額外元件。詳情請參閱營利總覽。如要瞭解如何管理公司和開發人員的營利功能，請參閱「管理公司和開發人員」。

機構名稱

機構名稱為：

  • 評估機構： username-eval
  • 付費機構：在初始佈建時由使用者定義

機構一經建立即無法變更名稱。

機構名稱會成為 API Proxy 的網址一部分，也會在向 Edge 管理 API 發出要求時，成為網址的一部分。舉例來說，用來存取 API Proxy 的一般網址格式如下：

http://org-name-env.apigee.net/v1/weather/forecastrss

其中：

  • org-name 是貴機構的名稱。
  • env 是 API Proxy 的部署環境，可以是 test 或 prod。

例如：

http://myorg-test.apigee.net/v1/weather/forecastrss

機構元件

下表詳細說明機構模型的元件：

元件 說明

組織

每個 Apigee 帳戶都會對應至 Apigee Edge 上的一或多個機構。這個機構包含所有元件的代表，包括 API Proxy、API 產品、API 套件、應用程式和開發人員。

帳戶持有人不限於單一機構。部分帳戶擁有者可能會定義或加入多個機構，這些機構支援不同的應用程式開發人員社群。
環境 機構中 API Proxy 的執行階段執行作業結構定義。如要進一步瞭解環境，請參閱下文。

使用者

在機構中，建立帳戶的人會自動成為管理員，您可以建立更多使用者。使用者會組成機構的 API 團隊，成員包括管理員、API Proxy 和 API 產品建立者、監控 Analytics 和其他統計資料的使用者等。

每位使用者可具備不同的角色和存取權限，舉例來說，您可以將部分使用者定義為機構管理員和營運管理員，並授予修改機構及其元件的權限。定義其他使用者，讓他們有權建立 API 代理和 API 產品，但無權修改其他使用者。

使用者可以同時屬於多個機構。舉例來說，貴公司可能會在 Apigee Edge 上定義多個機構，以支援不同的開發人員社群。不過，API Proxy 和 API 產品都是由同一批人建構，因此他們是所有機構的成員。

您不必建立 Apigee 帳戶 (也就是建立 Apigee 機構)，即可成為使用者。管理員可以將您新增至現有機構。

所有使用者都可透過以下網址登入 Apigee Edge： https://enterprise.apigee.com。

API Proxy

機構中的使用者會建立一或多個 API Proxy。API Proxy 會定義公開可用的 HTTP 端點與後端服務的對應關係。API Proxy 也可以設定為納入安全性 (例如 OAuth)、執行訊息轉換 (例如 XML 轉為 JSON)、限制後端服務的流量，以及對要求、回應和服務呼叫執行其他有價值的作業。

Edge 會收集 API Proxy 的數據分析資料。

API 產品

機構中的使用者會建立一或多個 API 產品，其中 API 產品是 API Proxy 與服務方案的組合。該服務方案可設定 API 代理的存取限制、提供安全性、允許監控和分析，以及提供額外功能。

Edge 會收集 API 產品的數據分析資料。

開發人員

機構組織包含一或多位開發人員，他們會建構使用 API (組合成 API 產品) 的應用程式，而這些 API 是由貴機構組織定義。開發人員可使用 API，但無法建立 API 或在機構中執行任何其他動作。

開發人員可以是貴公司的內部人員、合作夥伴，也可以是付費存取 API 的外部開發人員。

開發人員必須先在貴機構註冊，才能註冊應用程式並取得 API 金鑰，以存取您的 API。身為 API 提供者，您有權決定如何在貴機構中新增、更新或移除開發人員。您可以透過 Edge 管理 UI 手動新增開發人員、建立開發人員入口網站，透過網站註冊開發人員，或使用 Edge 管理 API 定義自己的註冊機制。

開發人員不一定要有 Edge 帳戶，而且大部分開發人員都不需要瞭解 Edge。如果開發人員在 Edge 上有帳戶，通常是屬於其他機構的使用者，或是使用 Edge API 服務。

應用程式

開發人員會建立一或多個使用您 API 的用戶端應用程式。

開發人員必須向貴機構註冊應用程式。Edge 中的應用程式代表開發人員的實際應用程式，可為開發人員提供 API 金鑰，以便在每次對 API 發出要求時傳遞金鑰。

由於所有應用程式都會在貴機構中註冊，因此您可以使用 Edge 監控及收集應用程式和 API 用量的分析資訊。

API 金鑰/OAuth 權杖

視您為 API 定義的授權機制而定，應用程式會連同對 API 發出的每項要求，一併傳遞 API 金鑰。如果金鑰有效，系統就會允許要求。Edge 支援不同類型的驗證，例如簡單的 API 金鑰、雙向 OAuth、三向 OAuth 等。

身為 API 供應商，您必須定義開發人員註冊應用程式的方式。開發人員註冊應用程式後，您會將存取 API 必要的金鑰傳回給他們。

註冊應用程式時，開發人員可以選擇存取單一或多個 API 產品。開發人員的實際應用程式會使用同一組金鑰，存取與應用程式相關聯的所有 API 產品 (開發人員應用程式在 Edge 中的註冊代表)。

您可以隨時撤銷金鑰，這樣開發人員的應用程式就無法再存取您的 API (即使開發人員應用程式的註冊代表仍存在於貴機構中)。或者，您也可以為金鑰設定時間限制，讓開發人員必須在特定時間後重新整理金鑰。

關於環境

「環境」是機構中 API Proxy 的執行階段執行作業結構定義。 您必須先將 API Proxy 部署至環境，才能存取該 Proxy。您可以將 API Proxy 部署至單一或多個環境。

一個機構可以包含多個環境。舉例來說，您可以在機構中定義 dev、test 和 prod 環境。

組織提供部分 Apigee 功能的範圍。舉例來說，您可以在機構層級提供鍵/值對應 (KVM) 資料，也就是說，部署至任何環境的 API Proxy 都會從 KVM 取得相同資料。部分功能 (例如快取) 可限定在機構或機構內的特定環境使用。Apigee 數據分析資料會依機構和環境的組合進行分割。

下方顯示您在機構內管理的主要實體，包括在機構中全域定義的實體，以及專為環境定義的實體：