使用 Drupal 7 建構入口網站

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

開發人員入口網站提供的社交發布功能,越來越常用於與開發人員社群溝通。這包括傳達靜態內容 (例如 API 說明文件和使用條款),以及社群貢獻的動態內容 (例如網誌和論壇)。

身為 API 供應商,您需要提供方式來公開 API、向開發人員說明 API、讓開發人員註冊,以及讓開發人員註冊應用程式。向開發人員公開 API 只是建立真正活絡社群的一部分。您也需要提供開發人員社群提供意見、提出支援和功能要求,以及提交其他開發人員可存取的內容。

Apigee Edge 提供 Developer Services 入口網站,方便您建構及發布自訂網站,為開發人員社群提供所有這些服務。每位 Edge 客戶都能在雲端或內部建立自己的開發人員入口網站。

以下影片介紹 Apigee Developer Services 入口網站。

下圖顯示預設開發人員入口網站的首頁:

預設開發人員入口網站的首頁

開發人員入口網站基本上是基於開放原始碼 Drupal (http://www.drupal.org) 專案的內容管理系統 (CMS)。Drupal 提供一系列核心功能,以模組的形式呈現,讓您輕鬆建立網站內容並進行管理。

開發人員入口網站可讓您建立 API 說明文件、支援網誌功能,並提供交流論壇。您也可以依據特定需求自訂開發人員入口網站。您可以透過自訂功能修改入口網站的外觀,以及開發人員與入口網站互動的方式。

您可以使用 Drupal 選單執行大部分的自訂作業。如果您以具備管理員權限的使用者身分登入入口網站,每個入口網站頁面的頂端都會顯示 Drupal 選單:

登入後,Drupal 選單會顯示在入口網站頂端。

管理員可以控管開發人員要求存取入口網站的程序、開發人員註冊存取 API 的應用程式方式、指派與 API 相關的特定角色和權限給開發人員,以及何時要撤銷開發人員的 API 存取權。

您也可以透過開發人員入口網站設定及控管營利功能。透過營利功能,開發人員可透過開發人員入口網站,自助存取帳單與報表、目錄與方案,以及營利專屬設定。

入口網站使用者類型

下圖顯示兩種類型的入口網站使用者:

入口網站使用者分為兩種:開發人員和團隊。以下詳細說明這些服務可執行的工作。

  • 開發人員是指使用您的 API 建構應用程式的使用者社群。應用程式開發人員可透過入口網站,透過 SmartDocs 瞭解您的 API,在入口網站上註冊帳戶、註冊使用您 API 的應用程式、與開發人員社群互動,以及在資訊主頁上查看應用程式使用量的統計資料。
  • API 團隊是 API 供應商,負責建立入口網站內容、提供 API 供應用程式開發人員使用、提供 API 說明文件,以及提供開發人員註冊應用程式和取得 API 金鑰的機制。API 團隊會執行開發人員入口網站的基本設定,以便:
    • 設定 API 金鑰的自動或手動要求
    • 維護 API 說明文件、論壇和網誌,並視需要修訂所有變更
    • 處理使用者留言和論壇管理
    • 強制執行角色型存取權控管 (RBAC),以控管使用者對入口網站功能的存取權。 舉例來說,管理員可以啟用控制項,允許已註冊使用者建立論壇貼文或使用測試控制台
    • 自訂電子郵件通知,向管理員和開發人員傳送使用者建立和核准通知
    • 自訂「與我們聯絡」等網頁表單

這張圖未顯示第三種入口網站使用者,也就是 API 產品管理員。API 產品經理負責定義 API 團隊建構入口網站的方式,包括:

  • 定義 API 的封裝方式
  • 定義應用程式核准規則
  • 如果在入口網站上啟用營利功能,請定義 API 產品的定價和計費方案。如要進一步瞭解營利功能,請參閱「營利總覽」。

自訂開發人員入口網站

身為 API 供應商,請考慮如何自訂開發人員入口網站,以便最適合您的 API,並為開發人員社群提供使用 API 所需的必要資訊。自訂入口網站的部分考量事項包括:

  • 輕鬆存取 API
  • 說明文件,例如操作指南和參考文件
  • 社群提供的內容,例如網誌和討論區
  • 程式碼範例
  • 簡易的註冊程序,可快速核准新的開發人員、應用程式和 API
  • 受管理的權利和憑證
  • 分層存取權控管
  • 與貴機構相符的外觀和風格

入口網站會預先定義基本設定。舉例來說,這個入口網站預設可讓任何人註冊為開發人員,但管理員必須核准每項註冊,開發人員才能登入入口網站。註冊核准後,開發人員就可以註冊應用程式來要求 API 金鑰,並使用入口網站存取 API 資源。

預設註冊程序的步驟如下:

  1. 開發人員會透過開發人員入口網站註冊。接著,入口網站會傳送電子郵件給管理員,請他們核准帳戶。
  2. 管理員核准帳戶後,系統會傳送電子郵件給開發人員,通知他們現在可以登入。
  3. 開發人員註冊應用程式,並選取應用程式使用的 API 產品。對此,入口網站會為應用程式指派專屬的 API 金鑰。
  4. 開發人員在向您的 API 提出要求時,會傳遞 API 金鑰。

這個開箱體驗可高度自訂。舉例來說,您可以覆寫預設註冊和授權配置,讓系統在註冊後自動核准並登入新開發人員。或者,您也可以要求開發人員先接受一組條款及細則,才能首次登入。

您也可以完全掌控開發人員入口網站上的內容。開發人員入口網站會提供範例內容,例如 API 說明文件、網誌文章和論壇討論內容。您可以提供自己的內容,並自訂每種內容類型的外觀。

詳情請參閱「自訂外觀」。

管理開發人員入口網站

開發人員會透過開發人員入口網站存取及使用您的 API。管理員執行帳戶管理工作,例如:

  • 自訂開發人員註冊程序,包括註冊欄位、內建的驗證碼,以及自動或手動核准
  • 新增或核准開發人員。根據預設,任何開發人員都可以透過開發人員入口網站註冊,但需要由管理員透過開發人員入口網站使用者介面核准。管理員也可以直接在入口網站上建立開發人員。開發人員會收到網站自動寄送的電子郵件,通知他們帳戶已建立完成。
  • 修改開發人員帳戶。舉例來說,管理員可以將使用者的帳戶狀態從「活躍」改為「已封鎖」,或是變更開發人員的個人資料資訊 (例如公司名稱)。
  • 移除開發人員。管理員可以停用或刪除開發人員的帳戶。
  • 指派角色和權限:管理員可以為開發人員帳戶指派特定角色。角色會與各種權限相關聯,例如建立書籍或其他內容的權限。您也可以變更與角色相關聯的權限,或建立新的角色。

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

開發人員入口網站功能摘要

下表列出開發人員入口的功能摘要:

功能 詳細資料
瀏覽器支援

請參閱「支援的軟體和支援版本」。

使用者註冊

  • 手動或自動核准新的開發人員帳戶
  • OpenID 整合
  • 支援 Twitter、Google 和 GitHub 的單一登入 (SSO) 服務
  • 人機驗證 (CAPTCHA)
  • 自訂欄位

使用者管理

  • 建立及編輯使用者
  • 指派角色

入口網站外觀

  • 透過 CSS、圖片和 Drupal 模組自訂

管理內容和社群

  • 以開放原始碼 (Drupal) 為基礎
  • 以範本為基礎的內容創作
  • 可立即用於 API 說明文件、網誌、論壇、常見問題的內容類型
  • Del.icio.us、Digg、Twitter 的自動連結
  • 內容修訂版本控制
  • 網誌的標記、關鍵字和封存內容
  • 與 Google Analytics 整合
  • 可自訂的內容熱門程度條件
  • 管理員審核論壇貼文和留言
  • 根據自訂角色、已登入和匿名使用者,提供不同的存取權

權限

  • 角色式存取規則

API 金鑰管理

  • 內建應用程式註冊
  • 支援自動或手動 API 金鑰核准
  • 管理員可以撤銷金鑰

電子郵件

  • 指定 SMTP 伺服器
  • 設定入口網站傳送電子郵件給開發人員的時間
  • 控管入口網站產生的電子郵件內容和格式

網誌

  • 建立、編輯及發布網誌文章
  • 以角色為基礎的權限,可限制特定使用者類型建立網誌

論壇

  • 建立討論串開發人員論壇
  • 視需要建立其他論壇類別
  • 依角色管理

說明文件

  • 製作 API 說明文件
  • 常見問題
  • 範例
  • 教學課程

選單

  • 控管選單外觀和內容

搜尋

  • 內建 Apache Solr 搜尋
  • 搜尋特定內容。例如論壇或網誌
  • 控管 Google 索引

連結檢查器

  • 檢查網頁是否有損毀的連結。
  • 控制連結檢查清單