註冊應用程式開發人員

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

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

簡介

Apigee 提供許多福利，但這完全取決於您是否知道誰在呼叫 API。舉例來說，API 安全性、流量管理和大量的分析資料都需要知道呼叫來源。而 Apigee 又是如何得知誰呼叫了您的 API？讀取每個 API 呼叫中的專屬資訊，例如使用者 ID、API 金鑰或 OAuth 權杖。這項專屬資訊會鎖定或解鎖您在 API 代理程式中建構的功能，讓您全面掌控 API 存取權和行為。

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

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

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

  • 如果您有付費的 Apigee 帳戶，開發人員可以透過開發人員入口網站自行註冊。如需詳細資訊，請根據開發人員入口網站的類型，參閱下列其中一個部分：
  • 系統管理員可以使用 API 註冊應用程式開發人員。
  • 開發人員入口網站管理員可以直接在入口網站中管理開發人員，如以下各節所述：
  • 機構管理員可以使用 Apigee UI 或 API 管理開發人員，詳情請參閱下文。

在開發人員入口網站管理使用者帳戶的最佳化建議

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

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

如果您使用以 Drupal 為基礎的開發人員入口網站，直接在開發人員入口網站上管理使用者帳戶可享有下列優勢：

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

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

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

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

探索「開發人員」頁面

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

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

前往開發人員

您可以透過「開發人員」頁面執行下列操作：

新增開發人員

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

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

另請參閱「管理使用者」。

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

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

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

  1. 前往「開發人員」頁面。
  2. 按一下要查看及編輯的開發人員資料列，即可開啟開發人員詳細資料。
  3. 在「Details」部分，系統會顯示下列資訊。 按一下 「編輯」，視需要編輯開發人員詳細資料。
    詳細資料 說明
    詳細資料 開發人員的姓名、使用者名稱和電子郵件地址；註冊狀態和期限；以及開發人員 ID。
    自訂屬性 為開發人員定義的自訂屬性。視需要設定自訂屬性。 詳情請參閱「管理開發人員的自訂屬性」一文。
    應用程式 已由開發人員註冊的應用程式。請參閱「註冊應用程式來控管 API 存取權」。
  4. 在「狀態」欄位中啟用或停用開發人員。
    詳情請參閱「啟用及停用開發人員」。

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

  • OAuth 存取權杖。這表示 OAuth 2 版政策中的 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 值區的讀取 + 寫入權限

如要進一步瞭解分層，請參閱下列資源：

如何匯出發布資料：

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

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

      前往開發人員

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

      前往「應用程式」

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

      前往「產品」

  3. 按一下 [匯出]。
  4. 系統會顯示「Save table as」對話方塊。輸入 Cloud Storage 值區名稱，並指定匯出格式 (JSON 或 CSV)。
  5. 按一下 [儲存]。長時間執行作業 (LRO) 開始。LRO 狀態會顯示在 「通知」圖示中。
  6. 匯出完成後，請按一下通知中的「下載」。檔案的 Cloud Storage 值區頁面隨即開啟。
  7. 按一下「下載」。檔案會下載到本機。
匯出資料的附註：
  • 匯出資料的結構會完全遵循 proto 定義，因此 proto 說明文件可用來做為匯出資料結構的參考資料。請參閱：
  • 與 Apigee Classic UI 不同，每個資源都有獨立的專屬匯出按鈕。
  • CSV 匯出作業不會列出 proto 中的任何重複或巢狀欄位，因為這些欄位無法正確呈現在資料表資料結構中。如要取得這項資訊，您必須使用 JSON 匯出功能。
  • 匯出的檔案名稱為 ExportFinal_{hash}。

刪除開發人員

如要刪除開發人員：

  1. 前往「開發人員」頁面。
  2. 將滑鼠游標懸停在要刪除的開發人員所在的列上。
  3. 依序按一下「更多」圖示 和「刪除」圖示 。
  4. 點選「刪除」即可確認刪除。

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

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

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

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

使用 API 管理開發人員

使用開發人員 API 管理開發人員。