您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
請按照下列各節所述,註冊及管理應用程式開發人員。(如要註冊應用程式,請參閱「註冊應用程式及管理 API 金鑰」一文,瞭解註冊應用程式是獨立的程序)。
簡介
Edge 提供許多福利,但這完全取決於您知道誰在呼叫 API。舉例來說,API 安全性、流量管理和大量的數據分析資料都需要知道呼叫來源。Edge 如何得知誰呼叫您的 API?讀取每個 API 呼叫中的專屬資訊,例如使用者 ID、API 金鑰或 OAuth 權杖。這項專屬資訊會鎖定或解鎖您在 API 代理程式中建構的功能,讓您全面掌控 API 存取權和行為。
因此,應用程式開發人員必須註冊才能使用您的 API。加入後,開發人員會註冊應用程式、選擇要使用的 API,並取得存取 API 所需的專屬 API 憑證 (消費者金鑰和密碼)。
如何註冊應用程式開發人員
請使用下列任一方法註冊應用程式開發人員:
- 如果您有付費的 Edge 帳戶,開發人員可以透過開發人員入口網站自行註冊。如需詳細資訊,請根據開發人員入口網站的類型,參閱下列任一節:
- 整合式入口網站:在整合式入口網站上建立開發人員帳戶
- Drupal 10:註冊應用程式開發人員帳戶
- Drupal 7:新增及管理使用者帳戶
- 系統管理員可以使用 API 註冊應用程式開發人員。
- 開發人員入口網站管理員可以直接在入口網站中管理開發人員,如以下各節所述:
- 整合式入口網站:點選「管理開發人員帳戶」即可管理開發人員帳戶。
- Drupal 10:應用程式開發人員如何與 Apigee Edge 模組互動
- Drupal 7:新增及管理使用者帳戶
- 機構管理員可以使用 Edge UI 或 API 管理開發人員,詳情請參閱下文。
在開發人員入口網站上管理開發人員帳戶的最佳化建議
Apigee 建議您直接在開發人員入口網站管理開發人員帳戶。
如果您使用整合式入口網站,這是確保整合式入口網站和 Edge 上的開發人員帳戶保持同步的唯一方法。
如果您使用以 Drupal 為基礎的開發人員入口網站,直接在開發人員入口網站上管理開發人員帳戶可享有下列優勢:
- 透過入口網站的管理員介面新增開發人員時,您可以為開發人員設定入口網站密碼,並觸發自動傳送電子郵件給開發人員的程序。
使用 Edge 新增或修改開發人員時,系統不會傳送電子郵件給開發人員,您也無法在入口網站上為開發人員設定密碼。因此,開發人員必須先在入口網站上重設密碼,才能登入入口網站。
- 您在入口網站上對開發人員帳戶所做的任何變更,都會自動傳送至 Edge。
如果您決定使用 Edge 管理以 Drupal 為基礎的開發人員帳戶,請務必在入口網站和 Edge 之間同步應用程式開發人員。
探索「開發人員」頁面
使用 Edge UI 和 Edge 傳統版 UI 存取及探索「開發人員」頁面。
Edge
如何使用 Edge UI 存取「開發人員」頁面:
- 登入 apigee.com/edge。
- 在左側導覽列中,依序選取「發布」>「開發人員」。
系統隨即會顯示「開發人員」頁面。
如圖所示,「開發人員」頁面可讓您執行下列操作:
Classic Edge (Private Cloud)
如要使用 Edge 傳統版 UI 存取「開發人員」頁面,請按照下列步驟操作:
- 登入
http://ms-ip:9000
,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。 - 依序選取頂端導覽列中的「發布」>「開發人員」。
系統隨即會顯示「開發人員」頁面。
新增開發人員
如要新增開發人員,請按照下列步驟操作:
- 前往「開發人員」頁面。
- 按一下「+ 開發人員」。
- 輸入開發人員詳細資料,包括姓名、電子郵件和使用者名稱。
- 按一下「建立」。
查看及編輯開發人員詳細資料
查看及編輯開發人員詳細資料。如果是已啟用營利功能的機構,您可以編輯設定營利屬性中定義的營利自訂屬性。
如要查看及編輯開發人員詳細資料,請按照下列步驟操作:
- 前往「開發人員」頁面。
- 按一下要查看及編輯的開發人員資料列,即可開啟開發人員詳細資料。
- 「詳細資料」部分會顯示以下資訊。視需要編輯開發人員詳細資料。
詳細資料 說明 詳細資料 開發人員的姓名、使用者名稱和電子郵件地址;註冊狀態和期限;以及開發人員 ID。
如要編輯開發人員詳細資料,請點選下列任一欄位:- 名字
- 姓氏
- 電子郵件
- 使用者名稱
自訂屬性 為開發人員定義的自訂屬性。視需要設定自訂屬性。詳情請參閱: 應用程式 已由開發人員註冊的應用程式。請參閱「註冊應用程式」。 - 在「狀態」欄位中啟用或停用開發人員。
詳情請參閱「啟用及停用開發人員」。
使用 Apigee Edge for Public Cloud 時,Edge 會在實體存取後,將下列實體保留在快取中至少 180 秒。
- OAuth 存取權杖。也就是說,在快取限制到期前,已撤銷的權杖最多可使用三分鐘。
- 金鑰管理服務 (KMS) 實體 (應用程式、開發人員、API 產品)。
- OAuth 權杖和 KMS 實體的自訂屬性。
管理開發人員的自訂屬性
為每位開發人員新增最多 18 個自訂屬性,包括「設定營利屬性」一文中所述的營利屬性。
如要管理自訂屬性,請按照下列步驟操作:
- 前往「開發人員」頁面。
- 找出要管理自訂屬性的開發人員,然後按一下對應的資料列,開啟開發人員詳細資料。
- 按一下「自訂屬性」部分中的「+」。
- 輸入屬性名稱和值。
- 按一下「」。
- 如要刪除自訂屬性,請將滑鼠游標懸停在屬性上,然後點選動作選單中的 。
啟用及停用開發人員
應用程式開發人員在入口網站中自行註冊時,您可以設定他們是否預設為有效。
開發人員處於閒置狀態時,仍可登入開發人員入口網站並建立應用程式,但任何對應的 API 金鑰都無法運作。即使開發人員處於停用狀態,開發人員的應用程式和 API 金鑰仍會保留已核准 (或其他) 的狀態。
如要啟用或停用開發人員,請按照下列步驟操作:
- 前往「開發人員」頁面。
- 按一下要啟用或停用的開發人員資料列,開啟開發人員詳細資料。
- 在「詳細資料」部分,將「狀態」欄位設為「啟用」或「停用」。
- 如果開發人員隸屬於多個機構,請重複執行這些步驟。
匯出發布資料
將下列發布資料匯出為半形逗號分隔值 (CSV) 檔案:
- 開發人員詳情
- 開發人員、應用程式和 API 產品詳細資料
如何匯出發布資料:
- 前往「開發人員」頁面。
- 按一下「匯出 CSV...」。
- 從下拉式選單中選取「開發人員」或「開發人員、應用程式和產品」。
系統會將所選發布資料下載為 CSV 檔案。
刪除開發人員
如要刪除開發人員:
- 前往「開發人員」頁面。
- 將滑鼠游標懸停在要刪除的開發人員資料列上,即可顯示動作選單。
- 按一下「」。
- 點選「刪除」即可確認刪除。
在入口網站和 Edge 之間同步處理應用程式開發人員
如果您使用以 Drupal 為基礎的開發人員入口網站發布 API,則使用 Edge 的應用程式開發人員所做的變更不會傳播至入口網站。您必須以入口網站管理員身分登入入口網站,並將入口網站與 Edge 同步處理,這些變更才會顯示在入口網站上。
如要將開發人員入口網站與在 Edge 中定義的應用程式開發人員同步,請參閱下列各節:
- Drupal 10:將開發人員與 Apigee Edge 進行同步
- Drupal 7:在入口網站和 Edge 之間同步應用程式開發人員
將開發人員分組為公司
在營利方面,公司是指以單一實體管理的開發人員集合。公司可以是任何適合貴機構的群組,例如業務單位、產品線或部門。如果您需要在單一公司實體下連結多位開發人員,將開發人員分組為公司就很實用。舉例來說,您可能需要為帳單目的設定不同的公司。不過,貴機構中的開發人員不需要與公司建立關聯。請注意,開發人員一律是單一實體,由電子郵件元素做為專屬識別碼。如果開發人員隸屬於某家公司,開發人員頁面就會顯示公司名稱。
如要進一步瞭解如何管理營利公司和開發人員,請參閱「管理公司和開發人員」。
設定營利屬性
使用使用者介面編輯開發人員,或是使用API 建立或編輯開發人員時,您可以設定下表中定義的營利屬性。編輯機構設定檔時,您會先設定機構的營利屬性。
欄位名稱 | 自訂屬性名稱 | 說明 |
---|---|---|
地址 | MINT_DEVELOPER_ADDRESS |
開發人員的地址,包括以下欄位:地址 (第 1 和第 2 行)、城市、州/省、郵遞區號和國家/地區。 |
帳單資料 | MINT_BILLING_PROFILE |
貴機構的帳單週期。有效值包括:
|
帳單類型 | MINT_BILLING_TYPE |
用於結帳的開發人員付款模式。這個值可以是下列其中一個:
請參閱「使用 API 設定預付和後付結帳類型」。 |
類別 | MINT_DEVELOPER_CATEGORY |
您要新增開發人員的開發人員類別。開發人員類別是指具有相似特徵的開發人員或公司組合。詳情請參閱「管理開發人員類別」。 |
公司 ID | MINT_COMPANY_ID |
公司 ID (如適用)。詳情請參閱「將開發人員分組為公司」。 |
開發人員類型 | MINT_DEVELOPER_TYPE |
Apigee 不會使用這個屬性。 開發人員類型。有效值包括: |
是否為中介商 | 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 管理開發人員
使用開發人員 API 管理開發人員。
使用 API 建立及更新開發人員時,您可以視需要設定「設定營利屬性」一文所述的營利屬性。