您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
Apigee Edge 提供簡單易用的整合式入口網站，可用來記錄及管理 API 存取權，並培養應用程式開發人員社群。
Apigee Edge 的所有使用者都能使用經過整合的入口網站開發工具，快速建構自己的開發人員入口網站，提供以 Drupal 為基礎的入口網站開發以外的替代方案。如需功能比較，請參閱「開發人員入口網站功能比較」。
請觀看這部短片，瞭解如何建立及發布整合式入口網站。
主要特色與優點
整合式入口網站提供下列主要功能和優點：| 功能 | 優點 |
|---|---|
| 入口網站內容開發 | 輕鬆快速地製作入口網站內容。
|
| 入口網站的外觀和風格 | 運用 SCSS 樣式表和個人化品牌宣傳，完全自訂入口網站的外觀和風格。 |
| API 說明文件 | 根據您的 OpenAPI 規格自動產生 API 參考說明文件。 |
| 自助式註冊 | 為開發人員提供自助式註冊服務，讓他們使用您的 API 建構應用程式。 |
| 目標對象管理 | 控管可存取入口網站內容和 API 的人員 |
| 數據分析 | 設定 Google Analytics (分析) 和自訂 Analytics (分析) 追蹤功能。 |
| 進階自訂 | 執行進階入口網站自訂功能，包括：
|
開始建構入口網站
Apigee 如何在整合式入口網站中因應安全性
下表說明 Apigee 如何透過整合式入口網站的內建功能因應安全性。
| 功能 | 地址 |
|---|---|
| 需要 HTTPS 和傳輸層安全性 (TLS) | 強制執行加密通訊 |
包含透過公開尾碼清單註冊的 apigee.io 網域
|
不允許 apigee.io 的子網域設定「supercookies」
|
| 支援內容安全政策 (CSP) 設定 | 防止跨網站指令碼攻擊 (XSS) 和其他程式碼插入攻擊 |
必要條件：
|
防範 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 傳送要求，以儲存應用程式的相關資訊。
下列各節將提供更多詳細資訊。
應用程式註冊資料和 API 金鑰的儲存位置
入口網站使用者在整合式入口網站上完成應用程式註冊程序後，入口網站會將應用程式資訊傳送至 Apigee Edge，包括應用程式名稱以及與該應用程式相關聯的 API 產品。如果 Edge 成功註冊應用程式，Edge 就會將單一 API 金鑰傳回入口網站。入口網站使用者會使用該 API 金鑰存取與應用程式相關聯的 API 產品。
應用程式和 API 金鑰的相關資訊只會儲存在 Edge 中，不會儲存在入口網站中。當入口網站使用者透過「我的應用程式」頁面 (例如「我的應用程式」頁面) 查看應用程式的相關資訊時，入口網站使用 API 金鑰向 Edge 發出要求，藉此存取該資訊。
同樣地，當入口網站使用者新增、移除或修改應用程式時，入口網站會將修改內容傳送至 Edge 以便儲存。
由於應用程式和 API 金鑰的所有相關資訊都儲存在 Edge 中，因此 Edge 管理員可以使用 Edge UI 或 Management API 修改資訊。舉例來說，管理員可以：
- 新增、移除或修改開發人員應用程式
- 核准或撤銷開發人員應用程式的 API 金鑰
詳情請參閱「註冊應用程式及管理 API 金鑰」。
應用程式開發人員帳戶資訊的儲存位置
開發人員帳戶資訊會儲存在 Edge 上，如下所示：
- 使用內建識別資訊提供者時，入口網站使用者建立帳戶時，這項資訊會儲存在識別資訊提供者，並顯示在「使用者」頁面。
- 若使用 SAML 識別資訊提供者，在入口網站使用者登入入口網站時，這些資訊的陰影記錄就會儲存在識別資訊提供者中，並顯示在「使用者」頁面上。
- 入口網站使用者註冊開發人員應用程式後，使用者帳戶資訊就會同步至 Edge，並在開發人員頁面上提供。
下列使用者帳戶資訊會儲存在 Edge 上：
- 姓名
- 電子郵件地址
- 使用者名稱
- 入口網站帳戶狀態 (有效或無效)
- 入口網站角色 (已驗證的使用者、管理員或其他)
- 角色權限
- 入口網站使用者所屬的團隊 (如果您已註冊加入團隊功能 Beta 版)
電子郵件地址是 Edge 用來識別開發人員的主鍵，每個金鑰皆不得重複。Edge 會透過主金鑰，為開發人員所屬的每個機構產生專屬開發人員 ID。
詳情請參閱「註冊應用程式開發人員」一文。
開發人員團隊資訊儲存位置 (Beta 版)
如果在入口網站使用者建立開發人員團隊，開發人員團隊資訊會儲存在 Edge 上，包括：
- 開發人員團隊名稱和說明
- 開發人員團隊成員及其角色
- 開發人員團隊獲派的應用程式
- 指派給開發團隊的目標對象
- 開發人員團隊的建立時間
系統會為開發團隊自動產生不重複的電子郵件地址，同時也是 Edge 用於識別開發人員團隊的主鍵。
詳情請參閱「透過開發人員團隊 (Beta 版) 分享應用程式的責任」和「管理開發人員團隊」。
關於範例入口網站
建立新的入口網站時，系統會提供一組起始網頁，供您做為跳轉點使用。新手網頁會提供示範內容，協助您以自己的獨特內容取代文字和圖片，啟發您的入口網站開發。入口網站主題範例使用 Material Design 主題設定和 SCSS。
以下是範例入口網站的首頁。
範例入口網站提供的起始網頁包括：
| 頁面 | 說明 |
|---|---|
| 首頁 | 說明展示 API 的入口網站首頁。這個選項會設為入口網站 (index.html) 的預設首頁。示範使用角質材質元件 (請參閱「新增角度質感元件」一文)。 |
| 快速啟動 | 這組快速入門步驟示範如何自訂入口網站。按一下範例入口網站的「快速入門」，逐步在「開始使用」頁面中新增內容。 |
| 立即開始 | 內容網頁範例。請參閱入口網站範例中的開始使用頁面，瞭解如何編輯這個頁面並將頁面新增至頂端。 |
| API | 可用的 API 清單。當您產生互動式 API 參考說明文件時，系統會自動在這個頁面中加入內容連結。 注意：這個頁面的內容是根據您發布至入口網站的 API 自動產生。您無法直接編輯這個頁面的內容，無法將其顯示在網頁清單中。您可以使用入口網站主題編輯器修改網頁的樣式。 |
| 我的應用程式 | 授權使用者的已註冊應用程式清單。請參閱「入口網站使用者如何與您的入口網站互動」。 注意：系統會根據已註冊的使用者應用程式自動產生本頁內容。您無法直接編輯網頁內容，而不會顯示在網頁清單中。您可以使用主題編輯器修改網頁的樣式。 |
| 登入 | 已註冊使用者的登入頁面。新使用者只要按一下「登入」，即可從這個頁面註冊。請參閱「入口網站使用者如何與您的入口網站互動」。 注意：「登入」頁面會自動納入您的入口網站。您可以在「登入」頁面上自訂標誌，並在「建立帳戶」頁面中新增自訂註冊欄位。您無法直接編輯網頁內容，而不會顯示在網頁清單中。 |
| 條款及細則 | 條款及細則頁面範例。 |
瀏覽器支援
Apigee 整合式入口網站支援與 Apigee Edge 相同的瀏覽器版本。