註冊應用程式開發人員

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

按照下列各節所述，註冊及管理應用程式開發人員。(應用程式註冊是獨立的程序，如「註冊應用程式及管理 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 和 Classic Edge UI 存取及探索「開發人員」頁面。

Edge

如何使用 Edge UI 存取「開發人員」頁面：

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

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

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

傳統邊緣 (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 存取權杖。這表示撤銷的權杖可能仍有最多三分鐘的成功，直到快取限製到期為止。
  • Key Management Service (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 上定義的應用程式開發人員同步處理，請參閱下列各節：

將開發人員歸入公司

營利計畫是由一群開發人員視為單一實體管理。公司可以是任何適合貴機構的分類，例如業務單位、產品系列或部門。當您需要在單一公司實體底下擁有多位開發人員相關聯時，將開發人員分為不同公司就非常實用。舉例來說，您可能需要為帳單用途設定不同的公司。不過，機構中的開發人員不必與公司建立關聯。請注意，開發人員一律是一個專屬實體，且可透過電子郵件元素明確識別。如果開發人員隸屬於公司，「開發人員」頁面中就會顯示公司名稱。

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

設定營利屬性

使用 UI 編輯開發人員，或使用 API 建立或編輯開發人員時，您可以設定下表定義的營利屬性。 系統預設會在編輯機構資料時設定機構的營利屬性。

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

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

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

  • PRORATED：帳單是依據 API 產品每月使用的天數計費。
  • CALENDAR_MONTH：帳單會按月處理。
帳單類型 MINT_BILLING_TYPE

用於計費的開發人員付款模式。這個值可以是下列其中一項：

  • PREPAID：開發人員使用 API 產品預先付費。使用 API 產品時，我們會從開發人員的餘額中扣除相應款項。開發人員必須保留預付餘額，才能購買 API 產品。
  • POSTPAID：開發人員需按月收取 API 產品使用費 (透過月結單)。開發人員依據帳單中方案所設的付費條件，支付 API 產品使用費用。
  • 兩者：支援兩種帳單類型。預設值為 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 建立及更新開發人員時，您可以視需要設定設定營利屬性中所述的營利屬性。