使用 Edge 管理公司和開發人員

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

如要進一步控管參與營利 API 計畫的公司和開發人員,例如為了測試目的建立內部公司和開發人員,您可以使用管理 UI 和 API 手動建立公司和開發人員。

決定是否需要手動建立公司和開發人員時,主要考量因素是開發人員是否需要憑證才能登入管理 UI、在呼叫 Edge 管理 API 時傳送憑證,或是登入開發人員入口網站。

  • 如果營利開發人員需要登入憑證才能存取 Edge UI 或 API,他們必須先擁有自己的 Apigee 管理員帳戶。
  • 如果您只需要建立不需要憑證的測試開發人員 (例如想使用虛構的測試開發人員發出 API 呼叫),則不需要 Apigee 帳戶。

透過使用者介面管理應用程式開發人員

使用 Edge UI 建立、管理及啟用應用程式開發人員,詳情請參閱「管理應用程式開發人員」。 建立應用程式開發人員後,即可將他們新增至公司,詳情請參閱下列章節。

透過使用者介面管理公司

請按照下列各節所述建立、管理及啟用公司。

探索「公司」頁面

存取「公司」頁面,詳情請見下文。

邊緣

如要使用 Edge 使用者介面存取「公司」頁面,請按照下列步驟操作:

  1. 登入 apigee.com/edge
  2. 在左側導覽列中,依序選取「發布」>「營利」>「公司」

系統會顯示「公司」頁面。

如圖所示,「公司」頁面可讓您:

Classic Edge (Private Cloud)

如要使用傳統 Edge UI 存取「公司」頁面,請按照下列步驟操作:

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

系統會顯示「公司」頁面。

  • 查看目前的公司清單
  • 管理公司。具體來說,您可以新增、啟用、編輯及刪除公司。
  • 查看已連結的開發人員入口網站 (僅限 Drupal 7)

新增公司

如要新增公司,請按照下列步驟操作:

  1. 存取「公司」頁面
  2. 按一下「+ 公司」
  3. 輸入公司詳細資料。

    必填欄位包括:

    • 公司名稱
    • 管理員 (主要公司管理員)
    • 帳單類型

    視營利帳單設定而定,「帳單類型」可能預設為 PREPAIDPOSTPAID。詳情請參閱「使用 API 設定預付和後付帳單類型」。

  4. 將一或多位開發人員新增至公司。
    1. 在「開發人員」部分,於「新增開發人員」欄位中輸入字串,即可顯示與該字串相符的開發人員清單。
    2. 從下拉式清單中選取開發人員。
    3. 重複上述步驟,即可為公司新增其他開發人員。
  5. 新增一或多個自訂屬性。
    1. 在「自訂屬性」部分,按一下「+ 新增」
    2. 輸入自訂屬性的名稱和值。
    3. 重複上述步驟,即可為公司新增其他自訂屬性。
  6. 按一下「建立公司」

啟用及停用公司

如何啟用及停用公司:

  1. 存取公司頁面
  2. 將游標懸停在要啟用的公司上,然後在動作選單中啟用
    停用切換鈕即可停用公司。

編輯公司

如要編輯公司,請按照下列步驟操作:

  1. 存取公司頁面
  2. 將游標懸停在要編輯的公司上,然後點選動作選單中的
  3. 視需要更新公司詳細資料。
  4. 按一下「更新公司」儲存變更。

刪除公司

如要刪除公司,請按照下列步驟操作:

  1. 存取「公司」頁面
  2. 將游標懸停在要刪除的公司上,然後按一下動作選單中的
  3. 按一下「刪除」確認刪除。

使用 API 管理公司和開發人員

以下各節將說明如何使用 API 管理公司和開發人員。

使用 API 建立及更新公司和開發人員

如要使用 API Edge Management API 管理公司和開發人員,請參閱下列 API 區段:

使用 API 管理開發人員角色

您可以使用營利 API 建立角色。您可以為合作夥伴設定角色。舉例來說,您可以為合作夥伴建立管理員和應用程式開發人員角色。然後將這些角色指派給特定合作夥伴員工。

建立開發人員角色

如要建立開發人員角色,請對 organizations/{org_name}/developer-roles 發出 POST 要求。提出要求時,您需要在要求主體中指定角色名稱和說明,以及機構的識別資訊。例如:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}"
   }
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

擷取開發人員角色

如要擷取開發人員角色,請對 organizations/{org_id}/developer-roles 發出 GET 要求。例如:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

回覆內容應如下所示 (僅顯示部分回覆):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

API 的開發人員角色設定

API 會公開下列開發人員角色設定選項:

名稱 說明 預設 是否必要?
name

開發人員角色的名稱。

N/A
description

開發人員角色的說明。

N/A

使用 API 擷取開發人員的稅率

您可以對 organizations/{org_name}/tax-engine 發出 GET 要求,取得開發人員目前的稅率。提出要求時,您需要將開發人員的 ID 指定為查詢參數。例如:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

回覆內容應如下所示:

0.09

使用 API 執行其他開發人員專屬工作

您為機構執行的許多營利相關工作,例如建立費率方案或建立通知條件,也可以為個別開發人員執行。舉例來說,您可以為特定開發人員建立銀行帳戶,或是為特定開發人員產生收益報表。

下表列出開發人員專屬工作,可使用營利 API 執行。表格中也會列出執行這些工作時,可參閱詳細操作說明的文章。

工作 如何查看操作說明
查看開發人員接受的條款及細則

查看開發人員或公司使用 API 時接受的條款及細則

查看開發人員接受的 API 套件

使用 API 查看開發人員或公司接受的 API 產品組合

建立開發人員費率方案

管理費率方案

查看開發人員可用的費率方案

瀏覽費率方案頁面

查看特定開發人員可用的費率方案,其中包含特定產品

使用 API 查看開發人員的已接受費率方案,其中包含 API 產品

僅供檢視已接受的開發人員費率方案

查看使用 API 的開發人員接受的所有費率方案

發放開發人員抵免額

發放抵免額

為開發人員設定信用額度

使用 API 設定信用額度上限

查看開發人員抵免額上限

使用 API 擷取信用額度

「加值」(在開發人員的預付餘額中新增金額)

管理預付帳戶餘額

查看開發人員的預付餘額

查看開發人員的預付帳戶餘額

為開發人員設定通知條件

使用通知範本設定通知

為開發人員建立及查看報表定義

管理報表