建構整合式入口網站

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

Apigee Edge 提供簡單易用的整合式入口網站，可記錄及管理 API 的存取權，並培養應用程式開發人員社群。

Apigee Edge 的所有使用者都能存取整合式入口網站開發工具，快速建構自己的開發人員入口網站，提供以 Drupal 為基礎的入口網站開發替代方案。如要比較功能，請參閱「開發人員入口網站功能比較」。

觀看這部短片，瞭解如何建構及發布整合式入口網站。

主要功能與優點

整合式入口網站提供下列主要功能和優點：
功能 優點
開發入口網站內容 輕鬆快速地開發入口網站內容。
  • 使用簡單易用的網頁編輯器建立網頁
  • 使用 Markdown 和 HTML 撰寫內容
  • 新增入口網站的導覽選單
入口網站的外觀和風格 使用 SCSS 樣式表和個人化品牌宣傳，全面自訂入口網站的外觀和風格。
API 說明文件 根據 OpenAPI 規格自動產生 API 參考文件。
自行報名 提供自助註冊功能，讓開發人員使用您的 API 建構應用程式。
目標對象管理 控管可存取入口網站內容和 API 的人員
Analytics 設定 Google Analytics 和自訂 Analytics 追蹤。
進階自訂 執行進階入口網站自訂作業，包括：
  • 自訂網域
  • 新增自訂註冊欄位
  • 使用指令碼擴充入口網站
  • 設定電子郵件

開始建構入口網站

Apigee 如何在整合式入口網站中處理安全性問題

下表說明 Apigee 如何透過整合式入口網站的內建功能解決安全性問題。

功能 地址
需要 HTTPS 和傳輸層安全標準 (TLS) 強制執行加密通訊
包括apigee.io網域註冊，並列於公開尾碼清單 禁止在 apigee.io 的子網域上設定「超級 Cookie」
支援內容安全政策 (CSP) 設定 防範跨網站指令碼攻擊 (XSS) 和其他程式碼注入攻擊
必要條件：
  • 表單輸入內容的清除作業
  • 管理員才能在整個網站中插入 JavaScript
 防範 HTML、SQL 或後端注入式攻擊
包含 x-content-type-options: nosniff XSS 標頭 禁止瀏覽器嘗試猜測 MIME 類型
包含 x-frame-options: deny XSS 標頭 禁止將入口網站內容嵌入 iFrame
包含 x-xss-protection: 1 XSS 標頭 偵測到反映型跨網站指令碼攻擊 (XSS) 時，禁止載入網頁
使用 CSRF 權杖 防範跨網站要求偽造
槓桿： 客戶資料保護措施

整合式入口網站如何與 Edge 通訊

開發人員入口網站使用的大部分資訊都儲存在 Apigee Edge。入口網站會做為 Edge 的用戶端，開發人員入口網站會視需要傳送 HTTP 或 HTTPS REST 要求，從 Edge 擷取資訊或將資訊傳送至 Edge。舉例來說，當入口網站使用者在入口網站上註冊新應用程式時，入口網站會傳送要求給 Edge，以儲存應用程式的相關資訊。

下列各節將進一步說明。

應用程式註冊和 API 金鑰的儲存位置

入口網站使用者在整合式入口網站完成應用程式註冊程序後，入口網站會將應用程式相關資訊 (包括應用程式名稱和與應用程式相關聯的 API 產品) 傳送至 Apigee Edge。如果 Edge 成功註冊應用程式，Edge 會將單一 API 金鑰傳回入口網站。入口網站使用者可透過該 API 金鑰，存取與應用程式相關聯的 API 產品。

應用程式和 API 金鑰的相關資訊只會儲存在 Edge，不會儲存在入口網站。當入口網站使用者透過入口網站 (例如「我的應用程式」頁面) 查看應用程式資訊時，入口網站會使用 API 金鑰向 Edge 發出要求，以存取相關資訊。

同樣地，當入口網站使用者新增、移除或修改應用程式時，入口網站會將修改內容傳送至 Edge 儲存。

由於應用程式和 API 金鑰的所有資訊都儲存在 Edge 中，因此 Edge 管理員可以使用 Edge UI 或管理 API 修改資訊。舉例來說，管理員可以：

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

詳情請參閱「註冊應用程式及管理 API 金鑰」。

應用程式開發人員帳戶資訊的儲存位置

Edge 會儲存開發人員帳戶資訊，如下所示：

Edge 會儲存下列使用者帳戶資訊：

  • 姓名
  • 電子郵件地址
  • 使用者名稱
  • 入口網站帳戶狀態 (有效或無效)
  • 入口網站角色 (已驗證使用者、管理員、其他)
  • 角色型權限
  • 入口網站使用者所屬的團隊 (如果您已註冊加入團隊功能的 Beta 版)

電子郵件地址是 Edge 用來識別開發人員的主鍵，且不得重複。Edge 會根據主鍵，為開發人員所屬的每個機構產生不重複的開發人員 ID。

詳情請參閱「註冊應用程式開發人員」。

開發人員團隊資訊的儲存位置 (Beta 版)

入口網站使用者在入口網站上建立開發人員團隊時，Edge 會儲存開發人員團隊資訊，包括：

  • 開發團隊名稱和說明
  • 開發人員團隊成員及其角色
  • 指派給開發人員團隊的應用程式
  • 指派給開發人員團隊的目標對象
  • 開發人員團隊的建立時間

系統會為開發人員團隊自動產生專屬電子郵件地址，做為 Edge 用來識別開發人員團隊的主要金鑰。

詳情請參閱「使用開發人員團隊共管應用程式 (Beta 版)」和「管理開發人員團隊」。

關於範例入口網站

建立新入口網站時，系統會提供一組入門頁面，供您做為起點。入門頁面包含示範內容，可協助您發想自己的入口網站開發方式，並以專屬內容取代文字和圖片。範例入口網站主題使用材質設計主題和 SCSS。

以下顯示範例入口網站的首頁。

範例入口網站提供的入門頁面包括：

網頁 說明
首頁 入口網站首頁，說明展示的 API。做為入口網站的預設首頁 (index.html)。示範如何使用 Angular Material 元件，如「新增 Angular Material 元件」一文所述。
快速入門 這組快速入門步驟會示範如何自訂入口網站。在範例入口網站中按一下「快速入門」，逐步將內容新增至「開始使用」頁面。
開始使用 內容網頁範例。請參閱範例入口網站的「開始使用」頁面，瞭解如何編輯這個頁面並新增至頂端導覽列。
API 可用 API 清單。產生互動式 API 參考文件時，系統會自動將內容連結新增至這個頁面。

注意：這個頁面的內容是根據您發布至入口網站的 API 自動產生。您無法直接編輯這個頁面的內容，且該頁面不會顯示在頁面清單中。您可以使用入口網站主題編輯器修改頁面樣式。
我的應用程式 授權使用者已註冊的應用程式清單。請參閱「入口網站使用者如何與您的入口網站互動」。

附註：本頁內容是根據已註冊的使用者應用程式自動產生。你無法直接編輯頁面內容，且該頁面不會顯示在頁面清單中。您可以使用主題編輯器修改頁面的樣式。
登入 註冊使用者登入頁面。新使用者可以點選「登入」，從這個頁面註冊。請參閱「入口網站使用者如何與您的入口網站互動」。

注意：系統會自動在入口網站中加入登入頁面。您可以自訂登入頁面的標誌，並在「建立帳戶」頁面新增自訂註冊欄位。你無法直接編輯頁面內容，且頁面不會顯示在頁面清單中。
條款及細則 條款及細則頁面範例。

瀏覽器支援

Apigee 整合式入口網站支援的瀏覽器版本與 Apigee Edge 相同。