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

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

開發人員服務入口網站會扮演 Apigee Edge 的用戶端。也就是說，入口網站無法做為獨立系統運作。相反地，入口網站使用的大部分資訊其實是儲存在 Edge 中。必要時，入口網站會提出 HTTP 或 HTTPS 要求，從 Edge 擷取資訊，或將資訊傳送至 Edge。

Edge 不會向入口網站提出要求，只會回應入口網站提出的要求。因此，Portal 會啟動與 Edge 之間的所有互動。

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

以下是入口網站與 Edge 進行通訊時需要的三項資訊。

  • Edge 網址 端點

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

    私有雲端安裝作業的網址格式為：http://EdgePrivateCloudIp:8080/v1 或 https://EdgePrivateCloudIp:TLSport/v1。

    其中 EdgePrivateCloudIp 是 Edge 管理伺服器的 IP 位址，而 TLSport 是 Edge 管理 API 的 TLS/SSL 通訊埠。例如 8443。
  • Apigee 機構名稱

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

    從入口網站到 Edge 的呼叫會經過驗證，且需要具備開發人員管理員權限的使用者。當開發人員入口網站為您佈建時，系統會將開發人員管理員角色新增至貴機構。這個角色包含名為 devadmin+{org_name}@apigee.com 的單一使用者，僅用於將開發人員入口網站連結至 Edge 機構。由於入口網站會顯示 Edge 開發人員應用程式、API 產品等，因此必須透過需要驗證的管理 API 呼叫，與 Edge 機構保持同步。開發人員管理員「使用者」具備必要權限。

如何查看連線資訊：

  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」中輸入貴機構名稱。
  3. 在「Management API Endpoint URL」(管理 API 端點網址) 中輸入 Edge 端點的網址。
  4. 在「已驗證的端點使用者」和「已驗證使用者的密碼」中輸入機構管理員的憑證。
  5. 選取「測試連線」，確認連線是否成功。
  6. 選取「儲存設定」。

確保可透過入口網站存取 Edge

由於入口網站使用的大部分資訊都儲存在 Edge 中，因此您必須確保入口網站可以存取 Edge。入口網站會透過 HTTP 和 HTTPS 提出 REST 要求，藉此與 Edge 建立連線。舉例來說，當開發人員在入口網站上註冊新應用程式時，該入口網站會向 Edge 提出要求，將應用程式相關資訊傳送給 Edge。

Edge 和入口網站都能在雲端或內部部署，您也可以混合使用不同類型的部署。舉例來說，您可以將兩者都部署在雲端，或部署在雲端和地端：

  • 如果入口網站和 Edge 都由 Apigee 在雲端部署，那麼從入口網站向 Edge 提出要求應該不會有任何問題。
  • 如果您在內部部署入口網站，則必須確保入口網站可以向 Edge 提出要求，無論 Edge 是部署在雲端還是內部皆然。
  • 如果您在內部部署 Edge，則必須確保入口網站可以存取 Edge。也就是說，無論入口網站是在雲端還是在內部部署，Edge 伺服器都必須接受來自入口網站的要求。

影片：觀看這部短片，進一步瞭解開發人員入口網站如何與 Apigee Edge 通訊，並確保連線正常運作。

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

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

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

應用程式和 API 金鑰的資訊並不會實際儲存在入口網站中。相反地，所有這類資訊都會儲存在 Edge 中。因此，每當開發人員使用入口網站查看應用程式相關資訊時，該入口網站就會向 Edge 提出要求，以便存取該資訊。開發人員每次修改應用程式時，入口網站都會自動將這些修改內容傳送至 Edge。

舉例來說，開發人員登入入口網站，然後前往「我的應用程式」頁面。為了填入「我的應用程式」頁面，入口網站會向 Edge 提出要求，擷取開發人員的應用程式和 API 金鑰相關資訊。這項資訊隨即會顯示在入口網站的「我的應用程式」頁面中：

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

由於應用程式和 API 金鑰的所有資訊都儲存在 Edge 中，Edge 管理員可以使用 Edge UI 操作這些資訊。舉例來說，管理員可以：

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

以下是同一個應用程式「My Weather App」在 Edge 使用者介面中顯示的樣子：

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

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

Edge 中儲存的開發人員資訊包括：

  • 名字
  • 姓氏
  • 電子郵件地址
  • 透過入口網站傳送的選用額外資訊

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

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

開發人員登入入口網站時，入口網站會負責驗證開發人員，並強制執行角色型權限。

由於入口網站會儲存所有開發人員的資訊，因此請將入口網站視為開發人員資訊的記錄系統，而非 Edge。開發人員在入口網站上修改資訊後，該資訊會儲存在入口網站上，並視需要傳送至 Edge。舉例來說，如果開發人員變更自己的名字，系統會將該資訊傳送至 Edge。但如果開發人員變更密碼，該資訊只會儲存在入口網站的本機上。

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

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

Edge 不會啟動與入口網站的通訊。如果您是 Edge 管理員，並在 Edge UI 中操作開發人員的相關資訊，則無法保證該資訊何時會推送至入口網站。因此，請使用入口網站的管理功能建立、修改及刪除開發人員，而非使用 Edge。

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

如何在 Edge 上同步入口網站與應用程式開發人員

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