在 Drupal 型入口網站與 Edge 之間通訊

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

開發人員服務入口網站就像 Apigee Edge 的用戶端。這表示入口網站無法做為獨立系統。入口網站使用的大部分資訊實際上會儲存在 Edge。入口網站會在必要時提出 HTTP 或 HTTPS 要求,藉此從 Edge 擷取資訊,或是將資訊傳送至 Edge。

Edge 不會向入口網站發出要求,只會回應從入口網站提出的要求。 因此,入口網站和 Edge 之間的所有互動都會由入口網站啟動。

設定入口網站和 Edge 之間的連線

入口網站需要與 Edge 通訊的三項資訊,如下所述。

  • Edge 的網址 端點

    雲端式 Edge 版本的預設端點為 https://api.enterprise.apigee.com/v1

    如要安裝私有雲,網址格式為:http://EdgePrivateCloudIp:8080/v1https://EdgePrivateCloudIp:TLSport/v1

    其中 EdgePrivateCloudIp 是 Edge Management Server 的 IP 位址,TLSport 則是 Edge Management API 的 TLS/SSL 通訊埠。例如 8443。
  • Apigee 機構名稱

    這是貴機構在 Edge 上的名稱。您在 Edge 上建立帳戶時就設定機構。
  • 開發人員管理員的使用者名稱和密碼

    從入口網站對 Edge 的呼叫會通過驗證,且需要具備「開發人員管理員」權限的使用者。佈建開發人員入口網站後,貴機構就會新增開發人員管理員角色。這個角色 (包括名為「devadmin+{org_name}@apigee.com」的單一使用者) 的用途是將開發人員入口網站連結至 Edge 機構。由於入口網站會顯示 Edge 開發人員應用程式、API 產品等項目,因此必須執行需要驗證的管理 API 呼叫,讓這個入口網站與您的 Edge 機構保持同步。devadmin「使用者」具備必要權限。

如何查看連線資訊:

  1. 在 Drupal 管理選單中,依序選取「Configuration」>「Dev Portal」>「Application Settings」

如何變更設定:

變更設定的方式會因入口網站的安裝和入口網站版本而異:

  • 以雲端為基礎的入口網站 15.01.06 以上版本:您必須向 Apigee Edge 支援團隊提出要求,才能變更連線資訊。例如,如果您想變更機構名稱。
  • 地端部署安裝及雲端式入口網站至 15.01.06 版:請按照下列說明變更連線資訊:
  1. 在 Drupal 管理選單中,依序選取「Configuration」>「Dev Portal Settings」
  2. 在「Management API Organization」(管理 API 機構) 中輸入貴機構名稱。
  3. 在「Management API Endpoint URL」(管理 API 端點網址) 中輸入 Edge 端點網址。
  4. 在「端點驗證使用者」和「已驗證使用者的密碼」中輸入機構管理員憑證。
  5. 選取「Test Connection」,確認連線成功。
  6. 選取「Save Configuration」

確保從入口網站存取 Edge

由於入口網站使用的大部分資訊會儲存在 Edge 中,因此您必須確保入口網站可存取 Edge。入口網站會透過 HTTP 和 HTTPS 發出 REST 要求,藉此與 Edge 進行通訊。舉例來說,當開發人員在入口網站註冊新的應用程式時,入口網站會向 Edge 發出要求,將應用程式相關資訊傳送至 Edge。

邊緣和入口網站皆可部署至雲端或地端部署環境,且可以混合部署類型。舉例來說,您可以同時在雲端和地端部署環境部署,也可以在雲端和地端部署環境中部署兩者:

  • 如果入口網站和 Edge 都是由 Apigee 部署至雲端,從入口網站至 Edge 傳送要求時應不會發生問題。
  • 如要部署地端部署入口網站,無論 Edge 是部署於雲端或地端部署環境,皆須確保入口網站能向 Edge 發出要求。
  • 如要部署 Edge on prem,請確認入口網站可以存取 Edge。也就是說,無論入口網站已部署於雲端或地端部署環境,Edge 伺服器都必須接受來自入口網站的要求。

影片:請觀看短片,進一步瞭解開發人員入口網站如何與 Apigee Edge 通訊,以及確保連線正常運作。

透過入口網站管理應用程式和 API 金鑰

開發人員在入口網站上完成應用程式註冊程序後,入口網站會將應用程式相關資訊傳送至 Edge,包括應用程式名稱以及與該應用程式相關聯的 API 產品。

如果 Edge 成功註冊應用程式,Edge 會將單一 API 金鑰傳回入口網站。接著,開發人員會使用該 API 金鑰存取與應用程式相關聯的 API 產品。

應用程式和 API 金鑰的相關資訊實際上並未儲存在入口網站上。所有資訊都會儲存在 Edge。因此,只要開發人員透過入口網站查看應用程式的相關資訊,入口網站會向 Edge 發出存取該資訊的要求。只要開發人員修改應用程式,入口網站會自動將修改內容傳送至 Edge。

舉例來說,開發人員登入入口網站並前往「我的應用程式」頁面。為了填入「我的應用程式」頁面,入口網站會向 Edge 發出要求,以擷取開發人員的應用程式和 API 金鑰相關資訊。這些資訊隨即會顯示在開發人員入口網站的「我的應用程式」頁面上:

如果開發人員之後新增、移除或修改應用程式,入口網站會將修改內容傳送至 Edge。

由於應用程式和 API 金鑰的所有相關資訊都儲存在 Edge 中,因此 Edge 管理員可以使用 Edge UI 處理這類資訊。舉例來說,管理員可以:

  • 新增、移除或修改開發人員的應用程式
  • 撤銷或核准應用程式的 API 金鑰

下方顯示的「My Weather App」(我的天氣應用程式) 與 Edge UI 管理員顯示的相同應用程式相同:

透過入口網站管理開發人員

如果開發人員註冊成為入口網站使用者,系統會在 Edge 和入口網站中建立開發人員。因此,與應用程式和 API 金鑰不同的是,開發人員的相關資訊實際上會同時儲存在 Edge 和入口網站中。

儲存在 Edge 的開發人員資訊包括:

  • 名字
  • 姓氏
  • 電子郵件地址
  • 從入口網站傳送的額外資訊 (選填)

入口網站儲存的資訊與 Edge 相同,但也會儲存其他資訊,包括:

  • 入口網站密碼
  • 入口網站帳戶狀態:有效或已封鎖
  • 入口網站角色:已驗證的使用者、管理員或其他
  • 以角色為基礎的權限:決定開發人員可在入口網站上執行的動作

開發人員登入入口網站時,入口網站將負責驗證開發人員及強制執行角色權限。

由於入口網站會儲存開發人員的所有資訊,因此該入口網站視為開發人員資訊的記錄系統,而非 Edge。當開發人員在入口網站上修改資訊時,這類資訊會儲存在入口網站上,並在適用情況下傳送至 Edge。舉例來說,如果開發人員變更了自己的名字,這項資訊就會傳送至 Edge。如果開發人員變更密碼,這項資訊只會儲存在入口網站本機。

詳情請參閱「新增及管理使用者帳戶」。

在入口網站和 Edge 之間同步處理應用程式開發人員

Edge 不會與入口網站啟動通訊。如果您是 Edge 管理員,且會操控 Edge UI 中的開發人員資訊,則該資訊不一定會推送至入口網站。因此,請使用入口網站的管理功能建立、修改及刪除開發人員,而非 Edge。

入口網站管理員可以強制在入口網站和 Edge 之間進行同步處理,以便將資訊從 Edge 下載至入口網站。不過,如果只修改入口網站上的開發人員而非 Edge 上的開發人員,則無須執行這項同步處理作業。此外,由於 Edge 無法在您建立開發人員時設定密碼,因此任何在 Edge 上建立的開發人員都會將入口網站密碼設為隨機值。因此,開發人員必須先完成密碼復原程序,才能登入入口網站。

將入口網站與 Edge 上的應用程式開發人員同步處理

  • 以具備管理員或內容建立權限的使用者登入入口網站。
  • 在 Drupal 管理選單中選取「People」。
  • 選取頁面頂端的「Dev Portal Developer Sync」按鈕,即可與 Edge 上的應用程式開發人員同步。