瞭解機構

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

機構是 Apigee Edge 中的頂層容器，其中含有您所有 API Proxy 和相關資源。本主題的其他部分會進一步深入介紹機構，以下列出幾個實務要點：

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

    在 apigee.com/organizations/docs/proxies 中，/docs/ 圈起來。

  • 雖然您可能只建立了一個機構，但可做為其他機構的使用者或管理員，而且這些機構具有特定權限。在 Edge 管理 UI 中，如果屬於多個機構，可以按照「切換機構」一節的說明切換至其他機構。

  • 當您以機構管理員角色的身分使用 Management API 呼叫時，大多數呼叫中路徑必須包含機構。舉例來說，下列 Management 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
  • 付費機構：使用者在初始佈建時定義

機構建立後即無法重新命名。

在向 Edge Management API 提出要求時，機構名稱會成為您的 API Proxy 網址的一部分和網址的一部分。例如，用於存取 API Proxy 的一般網址如下：

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 Proxy 和 API 產品建立者、使用者監控數據分析和其他統計資料的人員。

每位使用者可具備不同的角色和存取權限。例如，將部分使用者定義為「機構管理員」和「作業管理員」，且有權修改機構及其元件。定義具有建立 API Proxy 和 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 Proxy 的存取限制、提供安全防護、允許監控與數據分析，並提供其他功能。

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

開發人員

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

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

開發人員必須在貴機構中註冊，才能註冊應用程式並接收 API 金鑰來存取 API。如果您是 API 供應商，可以自行決定如何在機構中新增、更新或移除開發人員。您可以透過 Edge Management API 手動新增這些屬性、建立開發人員入口網站以便透過網站進行註冊，或是利用 Edge Management 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 部署至單一環境，也可以部署至多個環境。

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

機構提供了部分 Apigee 功能的範圍。舉例來說，鍵/值對應 (KVM) 資料可在機構層級提供，這表示部署至任何環境的 API Proxy 也會從 KVM 取得相同的資料。部分功能 (例如快取) 可以限定為機構本身或機構中的特定環境。 Apigee 數據分析資料按機構與環境的組合劃分。

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