註冊應用程式開發人員

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

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

簡介

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

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

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

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

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

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

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

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

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

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

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

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

瀏覽「開發人員」頁面

使用 Edge UI 和傳統 Edge UI 存取及探索「開發人員」頁面。

邊緣

如要使用 Edge 使用者介面存取「開發人員」頁面，請按照下列步驟操作：

  1. 登入 apigee.com/edge。
  2. 在左側導覽列中，依序選取「發布」>「開發人員」。

系統隨即會顯示「開發人員」頁面。

如圖所示，「開發人員」頁面可讓您：

Classic Edge (Private Cloud)

如要使用傳統 Edge UI 存取「開發人員」頁面，請按照下列步驟操作：

  1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 在頂端導覽列中，依序選取「發布」>「開發人員」。

系統隨即會顯示「開發人員」頁面。

新增開發人員

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

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

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

查看及編輯開發人員詳細資料。如果機構已啟用營利功能，您可以編輯設定營利屬性中定義的營利自訂屬性。

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

  1. 前往「開發人員」頁面。
  2. 按一下要查看及編輯的開發人員資料列，開啟開發人員詳細資料。
  3. 「詳細資料」部分會顯示下列資訊。視需要編輯開發人員詳細資料。
    詳細資料 說明
    詳細資料 開發人員姓名、使用者名稱和電子郵件地址；註冊狀態和時間長度；以及開發人員 ID。
    如要編輯開發人員詳細資料，請點按下列任一欄位：
    • 名字
    • 姓氏
    • 電子郵件
    • 使用者名稱
    修改內容，然後按下 Enter 鍵確認變更。
    自訂屬性 為開發人員定義的自訂屬性。視需要設定自訂屬性。詳情請參閱：
    應用程式 開發人員已註冊的應用程式。請參閱「註冊應用程式」。
  4. 在「狀態」欄位中啟用或停用開發人員。
    詳情請參閱「啟用及停用開發人員」。

使用 Apigee Edge for Public Cloud 時，Edge 會在實體存取後，將下列實體保留在快取中至少 180 秒。

  • OAuth 存取權杖。也就是說，遭撤銷的權杖在快取限制到期前，最多仍可成功使用三分鐘。
  • 金鑰管理服務 (KMS) 實體 (應用程式、開發人員、API 產品)。
  • OAuth 權杖和 KMS 實體的自訂屬性。

管理開發人員的自訂屬性

每個開發人員最多可新增 18 個自訂屬性，包括「設定營利屬性」一文所述的營利屬性。

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

  1. 前往「開發人員」頁面。
  2. 找出要管理自訂屬性的開發人員，然後按一下對應的資料列，開啟開發人員詳細資料。
  3. 按一下「自訂屬性」部分的「+」。
  4. 輸入屬性名稱和值。
  5. 按一下「」。
  6. 如要刪除自訂屬性，請將游標懸停在該屬性上，然後點選動作選單中的 。

啟用及停用開發人員

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

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

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

  1. 前往「開發人員」頁面。
  2. 按一下要啟用或停用的開發人員資料列，開啟開發人員詳細資料。
  3. 在「詳細資料」部分中，視需要將「狀態」欄位設為「有效」或「無效」。
  4. 如果開發人員屬於多個機構，請重複上述步驟。

匯出發布資料

將下列發布資料匯出為半形逗號分隔值 (CSV) 檔案：

  • 開發人員詳情
  • 開發人員、應用程式和 API 產品詳細資料

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

  1. 前往「開發人員」頁面。
  2. 按一下「匯出 CSV...」。
  3. 從下拉式選單中選取「開發人員」或「開發人員、應用程式和產品」。

系統會將所選發布資料下載為 CSV 檔案。

刪除開發人員

如要刪除開發人員：

  1. 前往「開發人員」頁面。
  2. 將游標移到要刪除的開發人員所在列，顯示動作選單。
  3. 按一下「」。
  4. 點選「刪除」即可確認刪除。

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

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

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

將開發人員分組到公司

在營利功能中，公司是指做為單一實體管理的一組開發人員。公司可以是適合貴機構的任何分組，例如業務單位、產品系列或部門。如果需要將多位開發人員與單一公司實體建立關聯，將開發人員分組到公司就相當實用。舉例來說，您可能需要為帳單目的設定不同公司。不過，貴機構的開發人員不必與公司建立關聯。請注意，開發人員一律是單一實體，且會以電子郵件元素做為唯一 ID。如果開發人員隸屬於某間公司，「開發人員」頁面就會顯示該公司名稱。

如要進一步瞭解如何管理公司和開發人員的營利功能，請參閱「管理公司和開發人員」。

設定營利屬性

使用使用者介面編輯開發人員，或使用 API 建立/編輯開發人員時，您可以設定下表定義的營利屬性。 一開始，您可以在編輯機構設定檔時，設定機構的營利屬性。

欄位名稱 自訂屬性名稱 說明
地址 MINT_DEVELOPER_ADDRESS

開發人員地址，包括以下欄位：地址 (第 1 行和第 2 行)、城市、州/省、郵遞區號和國家/地區。
帳單資料 MINT_BILLING_PROFILE

貴機構的帳單週期。有效值包括：

  • PRORATED：系統會根據 API 產品在日曆月內的使用天數計費。
  • CALENDAR_MONTH：系統每月會收取費用。
帳單類型 MINT_BILLING_TYPE

用於帳單的開發人員付款模式。可能的值如下：

  • 預付：開發人員預先支付 API 產品的使用費用。使用 API 產品時，系統會從開發人員的餘額扣除款項。開發人員必須維持足夠的預付餘額，才能購買 API 產品。
  • POSTPAID：開發人員每月會收到帳單，支付 API 產品的使用費。開發人員會根據帳單中方案設定的付款條件，支付 API 產品的使用費用。
  • BOTH：支援任一帳單類型。預設值為 PREPAID。

請參閱「使用 API 設定預付和後付型計費方式」。

類別 MINT_DEVELOPER_CATEGORY 要新增開發人員的開發人員類別。開發人員類別是指具有類似特徵的開發人員或公司群組。詳情請參閱「管理開發人員類別」。
公司 ID MINT_COMPANY_ID 公司 ID (如適用)。詳情請參閱將開發人員分組到公司。
開發人員類型 MINT_DEVELOPER_TYPE Apigee 不會使用這項屬性。

開發人員類型。有效值包括：TRUSTED 或 UNTRUSTED
是否為中介商 MINT_IS_BROKER 指出收益是否以淨額為準的標記。
法定名稱 MINT_DEVELOPER_LEGAL_NAME 開發人員的法定姓名，會顯示在所有報表中。
注意：如果開發人員未與公司分組，且想訂閱已發布的費率方案，則必須提供這項屬性。
自結帳 MINT_HAS_SELF_BILLING 此標記用於指定是否啟用自結帳單。如果啟用 (true)，營利功能會產生自結月結單，而非收益分享聲明。自結月結單是詳細列出應付給開發人員金額的財務文件。代表開發人員向 API 供應商開立發票。
免稅授權號碼 MINT_TAX_EXEMPT_AUTH_NO 政府免稅編號 (如適用)。
稅率 MINT_APPROX_TAX_RATE 開發人員的概略稅率。指定十進位值，小數點前最多 3 個字元，小數點後最多 4 個字元。

使用 API 管理開發人員

使用 Developer API 管理開發人員。

使用 API 建立及更新開發人員時，您可以視需要設定「設定營利屬性」一節所述的營利屬性。