註冊應用程式開發人員

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

請按照下列各節所述，註冊及管理應用程式開發人員。(應用程式註冊是獨立的程序，詳情請參閱「註冊應用程式來控管 API 存取權」一文)。

簡介

Apigee 提供許多好處，但前提是您必須知道是誰在呼叫 API。舉例來說，API 安全性、流量管理和相當多的分析資料，都取決於瞭解呼叫者身分。Apigee 如何判斷是誰呼叫 API？方法是讀取每個 API 呼叫中的專屬資訊，例如使用者 ID、API 金鑰或 OAuth 權杖。這項專屬資訊會鎖定或解除鎖定您建構到 API Proxy 中的功能，讓您全面掌控 API 存取權和行為。

因此，應用程式開發人員必須註冊才能使用您的 API。新增後，開發人員會註冊應用程式、選擇要使用的 API，並取得存取 API 時所需的專屬 API 憑證 (消費者金鑰和密碼)。

警告：API 安全性、流量管理和開發人員/應用程式分析，取決於 API Proxy 設定是否正確。舉例來說，您需要在 Proxy 中加入正確的政策，例如 API 金鑰驗證或 OAuth 存取權杖驗證、配額強制執行和速率限制。這些政策會識別發出呼叫的特定開發人員和應用程式，進而強制執行 API 安全性、管理開發人員或應用程式專屬流量、擷取 API 數據分析資料，以及執行其他功能。從技術上來說，您可以開發不檢查 API 金鑰或存取權杖的開放式 API，這表示您不需要註冊開發人員。但我們強烈建議不要這麼做，因為您會失去 API 安全性、無法控管效能 (透過良好的流量管理)、無法取得分析資料，以及錯失 Apigee 提供的其他主要優勢。

如何註冊應用程式開發人員

請使用下列任一方法註冊應用程式開發人員：

• 如果您有付費 Apigee 帳戶，開發人員可以透過開發人員入口網站自行註冊。如要瞭解詳情，請根據開發人員入口網站類型參閱下列其中一個章節：
  • 整合式入口網站：在整合式入口網站上建立使用者帳戶
  • Drupal 10：註冊應用程式開發人員
• 系統管理員可以使用 API 註冊應用程式開發人員。
• 開發人員入口網站管理員可以直接在入口網站中管理開發人員，詳情請參閱下列各節：
  • 整合式入口網站：管理使用者，管理使用者帳戶。
    注意：使用者在整合式入口網站中建立應用程式後 (如本節所述)，使用者帳戶資訊會同步至 Apigee，並顯示在「開發人員」頁面。應用程式開發人員記錄會透過使用者的電子郵件地址，與帳戶建立關聯。如要進一步瞭解帳戶和相關聯應用程式資訊的儲存位置，請參閱「應用程式開發人員帳戶資訊的儲存位置」。
  • Drupal 10：瞭解應用程式開發人員如何與 Apigee 模組互動
• 機構管理員可以使用 Apigee UI 或 API 管理開發人員，詳情請參閱下列各節。

注意：當入口網站使用者在整合式入口網站中建立團隊時，開發人員團隊資訊會儲存在 Apigee 中，且系統會自動產生專屬電子郵件地址，做為 Apigee 用來識別開發人員團隊的主要金鑰。 詳情請參閱「開發人員團隊資訊的儲存位置 (Beta 版)」。

管理開發人員入口網站使用者帳戶的最佳做法

Apigee 建議您直接在開發人員入口網站管理使用者帳戶。

如果您使用整合式入口網站，這是確保整合式入口網站和 Apigee 中的使用者帳戶保持同步的唯一方法。

如果您使用 Drupal 開發人員入口網站，直接在開發人員入口網站中管理使用者帳戶，可享有下列優點：

• 透過入口網站的管理員介面新增開發人員時，您可以設定入口網站的開發人員密碼，並觸發系統自動傳送電子郵件訊息給開發人員。

  使用 Apigee 新增或修改開發人員時，系統不會傳送電子郵件給開發人員，您也無法在入口網站上設定開發人員的密碼。因此，開發人員必須先在入口網站重設密碼，才能登入入口網站。

• 入口網站上開發人員帳戶的任何變更，都會自動傳送至 Apigee。

如果您決定使用 Apigee 管理 Drupal 使用者帳戶，就必須在入口網站和 Apigee 之間同步處理應用程式開發人員。

瀏覽「開發人員」頁面

使用 Apigee UI 存取及探索「開發人員」頁面。

注意：如果是整合式入口網站，使用者帳戶的管理方式請參閱「管理使用者」一文。如「註冊應用程式」一文所述，開發人員在整合式入口網站中建立應用程式後，系統會建立個別的開發人員記錄，追蹤與使用者帳戶相關聯的應用程式，並在「開發人員」頁面中顯示。開發人員記錄會使用使用者的電子郵件地址建立關聯。

如要前往「發布」>「開發人員」頁面，請按照下列步驟操作：

前往「開發人員」

「開發人員」頁面可讓您：

• 新增開發人員
• 查看及編輯開發人員詳細資料，包括：
• 管理自訂屬性
• 啟用或停用開發人員
• 匯出發布資料
• 刪除開發人員
• 搜尋開發人員清單

新增開發人員

如要新增開發人員，請按照下列步驟操作：

1. 存取「開發人員」頁面。
2. 點選「+ 建立」。
3. 輸入開發人員詳細資料，包括姓名、電子郵件地址和使用者名稱。
4. 按一下「新增」。

另請參閱管理使用者。

查看及編輯開發人員詳細資料

查看及編輯開發人員詳細資料。

如要查看及編輯開發人員詳細資料，請按照下列步驟操作：

1. 存取「開發人員」頁面。
2. 按一下要查看及編輯的開發人員資料列，開啟開發人員詳細資料。
3. 「詳細資料」部分會顯示下列資訊： 按一下「編輯」，視需要編輯開發人員詳細資料。

   詳細資料	說明
   詳細資料	開發人員姓名、使用者名稱和電子郵件地址；註冊狀態和時間長度；以及開發人員 ID。
   自訂屬性	為開發人員定義的自訂屬性。視需要設定自訂屬性。 詳情請參閱「管理開發人員的自訂屬性」一文。
   應用程式	開發人員已註冊的應用程式。請參閱「註冊應用程式來控管 API 存取權」。

4. 在「狀態」欄位中啟用或停用開發人員。
   詳情請參閱「啟用及停用開發人員」。

Apigee 會在存取實體後，將下列實體保留在快取中至少 180 秒。

• OAuth 存取權杖。也就是說，OAuth v2 政策中的 ExpiresIn 元素無法在 180 秒內使存取權杖過期。
• 金鑰管理服務 (KMS) 實體 (應用程式、開發人員、API 產品)。
• OAuth 權杖和 KMS 實體的自訂屬性。

管理開發人員的自訂屬性

每個開發人員最多可新增 18 個自訂屬性。

如要管理自訂屬性，請按照下列步驟操作：

1. 存取「開發人員」頁面。
2. 找出要管理自訂屬性的開發人員，然後按一下對應的資料列，開啟開發人員詳細資料。
3. 按一下「Edit」(編輯)。
4. 在「自訂屬性」部分中，按一下「+ 新增屬性」。
5. 輸入屬性名稱和值。
6. 按一下 [儲存]。
7. 如要刪除自訂屬性，請依序點選「編輯」「刪除」「儲存」。

啟用及停用開發人員

應用程式開發人員在入口網站中自行註冊時，您可以設定是否預設為有效。

開發人員處於非使用中狀態時，仍可登入開發人員入口網站並建立應用程式，但對應的 API 金鑰將無法運作。即使開發人員處於非活躍狀態，開發人員的應用程式和 API 金鑰仍會保留核准 (或其他) 狀態，但此時無效。

注意：停用開發人員後，所有訊息處理器可能需要幾分鐘的時間才會更新變更。在此之前，開發人員應用程式的部分呼叫可能會成功。

如要啟用或停用開發人員，請按照下列步驟操作：

1. 存取「開發人員」頁面。
2. 按一下要啟用或停用的開發人員資料列，開啟開發人員詳細資料。
3. 按一下「Edit」(編輯)。
4. 在「詳細資料」部分中，視需要將「狀態」欄位設為「有效」或「無效」。
5. 按一下 [儲存]。
6. 如果開發人員隸屬多個機構，請重複上述步驟。

匯出發布資料

本節說明如何將開發人員、應用程式或 API 產品的發布資料匯出為半形逗號分隔值 (CSV) 檔案或 JSON 檔案。

需求條件：

• Cloud Storage 值區
• 具備要匯出資料的讀取權限
• Cloud Storage 值區的讀取 + 寫入權限

如要進一步瞭解 bucket，請參閱下列文章：

• 關於 Cloud Storage bucket
• 建立 bucket
• 列出值區

如要匯出發布資料，請按照下列步驟操作：

1. 建立 Cloud Storage bucket 或取得現有 bucket 的名稱。
2. 前往下列任一頁面：

   • 在 Google Cloud 控制台中，前往「發布」>「開發人員」頁面。

     前往「開發人員」

   • 在 Google Cloud 控制台中，前往「Distribution」>「Apps」頁面。

     前往「應用程式」

   • 在 Google Cloud 控制台中，前往「Distribution」(發布) >「API Products」(API 產品) 頁面。

     前往「產品」頁面

3. 按一下 [匯出]。
4. 系統會顯示「將表格另存為」對話方塊。輸入 Cloud Storage bucket 的名稱，並指定匯出格式 (JSON 或 CSV)。
5. 按一下 [儲存]。系統會啟動長時間執行的作業 (LRO)。LRO 狀態會顯示在「通知」圖示中。
6. 匯出完成後，按一下通知中的「下載」。系統會開啟檔案的 Cloud Storage 值區頁面。
7. 按一下「下載」。檔案會下載到本機。

匯出資料注意事項：

• 匯出資料的結構完全符合 Proto 定義，因此 Proto 文件可做為匯出資料結構的參考資料。請參閱以下指南和最佳做法：
  • 開發人員
  • 應用程式
  • API 產品
• 與 Apigee 傳統 UI 不同，每個資源都有獨立的專屬匯出按鈕。
• CSV 匯出內容不會列出任何來自 proto 的重複或巢狀欄位，因為這些欄位無法在表格資料結構中正確表示。如要取得這項資訊，必須使用 JSON 匯出功能。
• 匯出檔案的名稱為 ExportFinal_{hash}。

刪除開發人員

警告：刪除開發人員後，系統會將他們和相關構件 (例如應用程式和 API 金鑰) 從貴機構中完全移除。為避免永久刪除開發人員及其構件，建議您改為停用開發人員。

如要刪除開發人員：

1. 存取「開發人員」頁面。
2. 將游標移到要刪除的開發人員所在列。
3. 依序點按「更多」圖示 和「刪除」圖示 。
4. 點選「刪除」即可確認刪除。

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

如果您使用以 Drupal 為基礎的開發人員入口網站發布 API，透過 Apigee 對應用程式開發人員所做的變更不會傳播至入口網站。您必須以入口網站管理員身分登入入口網站，並將入口網站與 Apigee 同步處理，這些變更才會顯示在入口網站上。

注意：如果您使用 Drupal 型開發人員入口網站，Apigee 建議您直接在入口網站中管理應用程式開發人員，而非使用 Apigee。請參閱管理開發人員入口網站使用者帳戶的最佳做法。

如要將開發人員入口網站與 Apigee 中定義的應用程式開發人員同步，請參閱下列章節：

Drupal 10：將開發人員與 Apigee 同步

使用 API 管理開發人員

使用 Developer API 管理開發人員。