瞭解機構

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info

機構是 Apigee Edge 中的頂層容器，其中包含所有 API 代理程式和相關資源。雖然這個主題的其他部分會深入探討機構，以下是幾個實用的要點：

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

    在網址 apigee.com/organizations/docs/proxies 中，/docs/ 已圈選。

  • 雖然您可能只建立一個機構，但您可以以使用者或管理員身分加入其他機構，並取得特定權限。在 Edge 管理介面中，如果您屬於多個機構，可以切換至其他機構，詳情請參閱「切換機構」。

  • 以「機構管理員」角色的使用者身分使用 Management 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 代理程式網址的一部分，也會成為向 Edge 管理 API 提出要求時的網址一部分。舉例來說，用於存取 API 代理伺服器的一般網址格式如下：

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

其中：

  • org-name 是貴機構的名稱。
  • env 是 API Proxy 的部署環境，可能是測試或正式版。

例如：

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

機構組成

下表詳細說明瞭機構模型的組成：

元件 說明

機構

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

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

使用者

在機構內，帳戶建立者會自動成為管理員，這樣您可以建立更多使用者。使用者組成機構的 API 團隊，其中可能包括管理員、API 代理和 API 產品建立者、監控數據分析和其他統計資料的使用者，以及其他人員。

不同使用者可具備不同的角色和存取權限。例如，將部分使用者定義為具備修改機構及其元件的機構管理員和營運管理員。定義其他使用者，讓他們具備建立 API Proxy 和 API 產品的權限，但沒有修改其他使用者的特權。

使用者可以同時是多個機構的成員。舉例來說，貴公司可能會在 Apigee Edge 上定義多個機構，以支援不同的開發人員社群。但是在內部，同一個人員會建構所有 API Proxy 和 API 產品，因此也成為貴機構所有成員。

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

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

API Proxy

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

Edge 會收集資料，以便分析 API Proxy。

API 產品

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

Edge 會收集 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 產品。開發人員的實際應用程式會使用相同的金鑰存取與應用程式相關聯的所有 API 產品 (Edge 中開發人員應用程式的註冊表示法)。

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

關於環境

環境是機構中 API Proxy 的執行階段執行情境。您必須先將 API Proxy 部署至環境，才能存取 API Proxy。您可以將 API 代理程部署至單一環境或多個環境。

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

機構會為部分 Apigee 功能提供範圍。舉例來說，您可以在機構層級提供鍵/值對應 (KVM) 資料，這表示部署至任何環境的 API Proxy 都會從 KVM 取得相同資料。某些功能 (例如快取) 的範圍可設為機構，或機構內的特定環境。Apigee 數據分析資料會根據機構和環境組合進行區隔。

下方列出您在機構內管理的主要實體，包括在機構中全域定義的實體，以及專門針對環境定義的實體：