您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
如要註冊新的應用程式，開發人員會在「我的應用程式」頁面上選取「新增應用程式」按鈕。
入口網站會顯示預設應用程式註冊表單：
根據預設，開發人員只需要指定應用程式名稱、回呼網址，以及要新增至應用程式的 API 產品清單。
API 供應商可完全控管應用程式的註冊程序。舉例來說，您可以設定：
- 入口網站上可用的 API 產品清單
- 是否有預設的 API 產品
- 是否需要回呼網址
- API 金鑰是手動或自動核准的 API 產品
- 是否在「新增應用程式」頁面提供註冊應用程式所需的其他資訊
本主題說明如何設定入口網站的應用程式註冊流程。不過，本主題不會說明如何建立 API 產品，相關詳情請參閱：
您可以設定入口網站，禁止開發人員根據指派給開發人員的角色建立、刪除或編輯應用程式。例如，您可以設定入口網站，在開發人員註冊時為所有開發人員建立單一預設應用程式。隨後，您只允許部分開發人員新增應用程式，可能根據費用結構或其他開發人員的特性。運用角色和權限控管哪些開發人員能夠建立、刪除及編輯應用程式。詳情請參閱「新增及管理使用者帳戶」。
指定入口網站上提供的 API 產品
您可以透過以下兩種方式指定開發人員存取入口網站時可用的 API 產品：
在建立 API 產品時指定存取層級
建立 API 產品時，您必須指定產品的存取層級選項，如下所示：
如要進一步瞭解存取層級對 API 產品在 Drupal 7 開發人員入口網站中的可用性有何影響，請參閱「存取層級」。
根據角色限制 API 產品的存取權
啟用 API 產品角色 Access Drupal 模組之後，您就能指定可以存取各項 API 產品的角色。
如要根據開發人員角色限制 API 產品的存取權：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 查看開發人員入口網站角色和使用者指派作業：
- 在 Drupal 管理選單中選取「People」>「權限」>「角色」，然後視需要新增或編輯開發人員角色和權限。
- 在 Drupal 管理選單中選取「People」，然後視需要編輯使用者和角色指派設定。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Dev Portal」>「API Product Role Access」。
- 請選取要存取各個 API 產品的角色。
- 按一下「儲存設定」。
設定開發人員如何將 API 產品與應用程式建立關聯
如要註冊新的應用程式，開發人員在「我的應用程式」頁面上選取「新增應用程式」按鈕，即可開啟「新增應用程式」表單：
開發人員可以根據您設定入口網站的方式，在註冊應用程式時選取一或多個要與應用程式建立關聯的 API 產品。或者，您也可以指定指派給所有應用程式的預設產品。
註冊應用程式時，入口網站提供下列設定選項，讓您控管選取 API 產品：
- 切勿將應用程式與任何 API 產品建立關聯。
- 將所有應用程式與一或多個預設 API 產品 (在下方設定) 建立關聯。開發人員無法在應用程式中加入任何其他 API 產品。
- 允許選取單一 API 產品，但不一定要提供。
- 必須選取單一 API 產品。
- 允許選取多個 API 產品，但不需要選取。
- 允許選取多個 API 產品，且至少需要一項 API 產品。
您也可以控管開發人員用於選取 API 產品的表單中顯示的 HTML 元素。選項包括：
- 下拉式清單。
- 核取方塊或圓形按鈕。如果開發人員只能選取單一 API 產品，系統就會顯示多個核取方塊和圓形按鈕。
如要設定 API 產品選項：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Dev Portal Settings」>「Application Settings」。
- 在「應用程式設定」頁面中，展開「API 產品設定」區域。
- 在「API Product Handling」下方，選取控制 API 產品的選項。
- 如果您指定「將所有應用程式與一或多個預設 API 產品 (在下方設定) 建立關聯」選項，請在「預設 API 產品」下方設定預設產品。
- 在「API 產品小工具」下方，選取開發人員用來選取 API 產品的 HTML 元素。
- 儲存設定。
設定回呼網址處理
如果 API 產品中的 API Proxy 使用「三足式 OAuth」(授權碼授權類型)，開發人員必須在註冊應用程式時指定回呼網址。回呼網址通常會指定應用程式網址，該應用程式應用於接收代表用戶端應用程式的授權碼。此外，這個網址字串也會用於驗證。要求用戶端和存取權杖時，用戶端必須將這個網址傳送至 Apigee Edge，且 redirect_uri 參數必須與已註冊的參數值相符。詳情請參閱實作授權碼授權類型。
如要控管所選 API 產品的回呼網址：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Dev Portal Settings」>「Application Attributes」。
- 在「Application Settings」頁面中，展開「Callback URL settings」區域。
- 在「Callback URL Handling」下方，選取下列其中一個選項。
- 所有開發人員應用程式都必須提供回呼網址。
- 所有開發人員應用程式均為選用回呼網址。
- 回呼網址不是必要項目，也不會顯示。
- 儲存設定。
顯示應用程式使用情況數據分析
入口網站可以顯示應用程式使用情況的分析資訊。如果啟用數據分析功能，應用程式開發人員就能在「我的應用程式」頁面上查看每個應用程式的數據分析。舉例來說，開發人員可以顯示應用程式的下列數據分析：
- 處理量
- 回應時間上限
- 最短回覆時間
- 訊息數量
- 錯誤數
如何透過入口網站啟用數據分析功能：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Dev Portal」>「Application Settings」。
- 在「應用程式設定」頁面中，展開「應用程式效能設定」區域。
- 勾選「顯示開發人員應用程式數據分析」分頁標籤核取方塊。
- 在「要查詢數據分析資料的環境」部分，選取「測試」或「實際工作環境」。如果是可公開存取的入口網站，您通常會選取「正式版」。
- 儲存設定。
如何在入口網站上顯示應用程式的數據分析：
- 在「我的應用程式」頁面上選取應用程式名稱。
- 選取應用程式的 [Analytics (分析)] 連結。
- 選取要顯示的數據分析類型和日期範圍：
- 所選資訊會顯示：
手動核准或撤銷 API 產品的 API 金鑰
開發人員將 API 產品新增至應用程式，並註冊應用程式時，入口網站會將該應用程式的 API 金鑰傳回給開發人員。接著，開發人員會使用該 API 金鑰存取與該應用程式相關聯的 API 產品組合的 API Proxy。
您可以在建立 API 產品時，控管各項 API 產品的重要核准程序：
核准程序包括：
- 自動 - 開發人員註冊應用程式時，API 產品的入口網站會傳回核准的 API 金鑰。您之後可以撤銷自動核准的金鑰。
- 手動：開發人員註冊應用程式時，入口網站會傳回 API 金鑰，但任何使用手動金鑰核准的 API 產品都未啟用金鑰。API 金鑰必須由管理員透過 Edge 管理 UI 或 API 手動核准，開發人員才能使用該金鑰存取 API 產品。您日後可以撤銷手動核准的金鑰。
詳情請參閱「建立 API 產品」一文。
如果開發人員允許開發人員將多個 API 產品新增至應用程式，開發人員可能會透過自動金鑰核准功能新增某些產品，部分產品需要手動核准。在等待需要手動核准的產品最終通過核准之前，開發人員可將傳回的 API 金鑰立即用於所有自動核准的 API 產品。
如要查看應用程式的 API 產品清單，以及 API 產品金鑰的核准狀態，開發人員在「我的應用程式」頁面上選取應用程式名稱，然後選取「產品」連結：
在這個範例中，Premium Weather API 產品使用手動核准，並正在等待管理員核准金鑰。免費 API 產品會使用自動核准功能，且無法再透過金鑰存取產品。
如何手動核准或撤銷金鑰：
- 以具有貴機構管理員權限的使用者身分登入 Edge 管理 UI。
- 在右上角的下拉式方塊中，選取「API 平台」。
- 依序選取「發布」>「開發人員應用程式」，開啟開發人員應用程式清單。
- 選取「待處理」按鈕，即可查看有待處理金鑰要求的應用程式清單：
- 選取要核准的應用程式名稱。
- 在應用程式詳細資料頁面中，選取右上角的「編輯」按鈕。
- 在應用程式的 API 產品清單中，請在「動作」下方：
-
如要核准金鑰，請針對需要手動核准的各項 API 產品選取 [核准] 按鈕。
-
如要撤銷已核准的金鑰，請選取 API 產品「動作」下方的「撤銷」按鈕，藉此撤銷存取權。
-
如要核准金鑰，請針對需要手動核准的各項 API 產品選取 [核准] 按鈕。
- 儲存應用程式。API 金鑰現已通過核准。
控管 API 產品和應用程式快取
API 產品和開發人員應用程式的相關資訊會從 Apigee Edge 的入口網站遠端儲存。換句話說，您可以透過 Edge UI 或 API 對 API 產品和應用程式進行變更，無須透過入口網站。例如，後端管理員新增 API 產品後，入口網站不會立即以該資訊更新，
如要確保入口網站與 Edge 後端保持同步，您可以手動觸發入口網站快取的更新作業、在入口網站的 Cron 工作執行時自動更新快取，或兩者並用。舉例來說，如果您將 Cron 工作設定為頻繁執行 (例如每 5 或 10 分鐘執行一次)，您可能不希望經常需要更新 API 產品和開發人員應用程式快取的負擔。在這種情況下，您可以手動觸發快取更新作業。不過，如果 Cron 工作每小時或兩小時執行一次，更新快取所需的時間可能就不會帶來太大的影響。
根據預設，入口網站會設為在每次執行 Cron 時重新建構 API 產品和開發人員應用程式快取。
指定是否要在每次 Cron 執行時重新建構 API 產品和開發人員應用程式快取：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 選單中，依序選取「Configuration」>「Dev Portal Settings」>「Application Settings」。
- 勾選或取消勾選「每次執行 Cron 時重新建構 API 產品和開發人員應用程式快取」。
- 儲存設定。
如何手動更新快取：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 選單中，依序選取「首頁」圖示 >「清除所有快取」。
自訂用來註冊應用程式的表單欄位
當開發人員註冊應用程式時，入口網站會顯示預設表單：
如果您是 API 供應商，建議您修改這份表單，提示開發人員提供其他資訊，例如客戶 ID、應用程式的目標平台或其他資訊。入口網站可讓您在這份表單中新增欄位。這些欄位可以是：
- 必填或選填
- 以不同的 HTML 元素顯示，例如文字方塊、圓形按鈕、核取方塊等
- 可設定為顯示在表單中「回呼網址」欄位與「產品」欄位之間的任何位置
如要瞭解如何自訂開發人員入口網站提供的應用程式註冊表單，請觀看這部影片。
舉例來說，以下表單顯示客戶 ID 的必填欄位，以及目標平台的選填欄位：
在表單中新增欄位時，系統會在開發人員提交表單時，自動將欄位值連同所有其他欄位一起上傳至 Edge。也就是說，您可以在 Edge 上查看或修改這些欄位，或使用 Edge Management API 透過指令碼存取這些欄位。
舉例來說，您可以前往「發布」>「開發人員應用程式」，然後選取應用程式名稱，即可在 Edge 管理 UI 中查看新表單欄位。新欄位值會顯示在頁面的「自訂屬性」區域下方，並顯示與欄位內部名稱對應的名稱：
在開發人員的「我的應用程式」頁面上，應用程式的「詳細資料」部分也會顯示欄位值：
開發人員也可以在「我的應用程式」頁面上選取應用程式的 [編輯] 連結來編輯值。
下列程序說明如何使用管理員介面，設定應用程式建立表單。Drupal 開發人員可以使用自訂掛鉤執行其他自訂動作，包括修改「我的應用程式」頁面。如要進一步瞭解如何透過程式碼變更行為，請參閱檔案中的應用程式 API 範例：/profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php。
如何在應用程式註冊表單中新增欄位：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 確認已啟用 DevConnect App Attribute Management 模組。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Dev Portal Settings」>「Dev Portal App Attributes」。
- 選取頁面頂端的「新增開發人員入口網站應用程式屬性」按鈕。
- 設定欄位。以上方顯示的「客戶 ID」欄位為例，請使用下列設定：
- 內部名稱 = cust_id。這就是用來儲存欄位值的變數名稱。
- Public Name = 客戶 ID
- 說明 = 輸入您的客戶 ID。
- 勾選「需要這個屬性」的核取方塊
- 勾選「顯示這個屬性」的核取方塊。
- 小工具 = 文字方塊
- 選取「儲存」即可返回開發人員入口網站的應用程式屬性頁面。
- 選取「儲存變更」。
- 從 Drupal 選單中依序選取「首頁」圖示 >「清除所有快取」。
您可能需要先清除瀏覽器快取，新的欄位才會顯示在表單中。
如要為開發人員新增選填欄位，以便指定應用程式的平台，請將欄位屬性設為：
- 內部名稱 = intent_platforms
- 公開名稱 = 平台
- 說明 = 為您的應用程式指定一或多個平台。
- 取消勾選「需要這個屬性」的核取方塊
- 勾選「顯示這個屬性」的核取方塊。
- 小工具 = 核取方塊清單
- 選取「儲存」即可返回開發人員入口網站的應用程式屬性頁面。
如何重新排序表單中的屬性：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Dev Portal Settings」>「Dev Portal App Attributes」。
- 選取「名稱」欄下方的加號「+」+，然後將屬性拖曳到要在表單中顯示的位置。
- 儲存變更。