查看 Apigee Edge 說明文件。
前往
Apigee X說明文件。 資訊
若想進一步控管參與營利內容的公司和開發人員 API 計畫。舉例來說,如果您要建立內部公司和開發人員, 測試目的—您可以使用管理 UI 手動建立公司和開發人員 和 API
判斷是否需要手動建立公司和開發人員的主要考量因素就是 無論開發人員是否需要憑證才能登入管理 UI,傳送 憑證,或是登入開發人員入口網站。
- 如果營利開發人員需要登入憑證才能存取 Edge UI 或 API,他們必須先有自己的憑證 Apigee 管理員帳戶。
- 如果您只需要建立無需憑證的測試開發人員 (例如 您要與虛構測試開發人員發出 API 呼叫),則沒有任何 Apigee 帳戶 這通常代表交易 不會十分要求關聯語意
使用 UI 管理應用程式開發人員
按照「管理應用程式開發人員」一文所述,使用 Edge UI 建立、管理及啟用應用程式開發人員。 建立應用程式開發人員後,您可以按照下列各節所述,將開發人員加入公司。
透過使用者介面管理公司
按照以下各節所述,建立、管理及啟用公司。
瀏覽「公司」頁面
按照下方說明存取「公司」頁面。
Edge
如何使用 Edge UI 存取「公司」頁面:
- 登入 apigee.com/edge。
- 選取「發布」>「發布」營利 >公司
畫面上會顯示「公司」頁面。
如上圖所示,「公司」頁面可讓您執行下列操作:
傳統版 Edge (Private Cloud)
如何使用傳統版 Edge UI 存取「公司」頁面:
- 登入「
http://ms-ip:9000
」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。 - 選取「發布」>「發布」公司。
畫面上會顯示「公司」頁面。
- 查看目前的公司清單
- 管理公司。具體來說,就是新增、啟用、編輯及刪除公司。
- 查看已連結的開發人員入口網站 (僅限 Drupal 7)
新增公司
如何新增公司:
- 存取「公司」頁面。
- 按一下「+ 公司」。
- 輸入公司詳細資料。
必填欄位包括:
- 公司名稱
- 管理員 (主要公司的使用者) 管理員)
- 帳單類型
根據營利帳單設定而定,帳單類型可能會預設為
PREPAID
或POSTPAID
。詳情請參閱使用 API 設定預付和後付計費類型。 - 將一或多位開發人員新增至公司。
- 在「開發人員」部分的「新增開發人員」欄位中輸入字串,以顯示與字串相符的開發人員清單。
- 從下拉式清單中選取開發人員。
- 重複上述步驟,為公司新增其他開發人員。
- 新增一或多個自訂屬性。
- 在「自訂屬性」部分中,按一下「+ 新增」。
- 輸入自訂屬性的名稱和值。
- 重複以上步驟,為公司新增其他自訂屬性。
- 按一下「建立公司」。
啟用及停用公司
如何啟用及停用公司:
- 存取公司網頁。
- 將遊標移到要啟用的公司上,然後在動作選單中啟用 。
將切換鈕停用即可停用公司。
編輯公司
如要編輯公司,請按照下列步驟操作:
- 存取公司網頁。
- 將滑鼠遊標懸停在要編輯的公司上,然後按一下動作選單中的 。
- 視需要更新公司詳細資料。
- 按一下「更新公司」即可儲存變更。
刪除公司
若要刪除公司:
- 存取「公司」頁面。
- 將滑鼠遊標懸停在要刪除的公司上,然後按一下動作選單中的 。
- 按一下「刪除」即可確認刪除作業。
使用 API 管理公司和開發人員
以下各節將說明如何使用 API 管理公司和開發人員。
使用 API 建立及更新公司和開發人員
如要透過 API Edge Management API 管理公司和開發人員,請參閱下列 API 章節:
- 建立公司
- 建立開發人員
注意:傳遞自訂屬性,在建立開發人員時設定營利資訊。 - 新增或
更新公司開發人員
注意:您可以視需要將角色指派給開發人員,但並非必要。若要取得 開發人員角色,請參閱擷取開發人員角色。 - 列出所有開發人員或單一開發人員的營利設定
注意:在設定營利資訊時傳送自訂屬性, 建立或 更新開發人員。 你可以查看使用標準 (非營利) API 設定的營利自訂屬性, 所有開發人員或 「單一開發人員」。
使用 API 管理開發人員角色
您可以使用營利 API 建立角色。這樣您就能建立角色 合作夥伴。舉例來說,您可以為 合作夥伴。再將這些角色指派給特定的合作夥伴員工。
建立開發人員角色
如要建立開發人員角色,請向
organizations/{org_name}/developer-roles
。提出要求時,您必須
在要求主體中指定角色名稱和說明,以及
並根據貴機構的使命
價值觀和目標進行調整例如:
$ 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
正在擷取開發人員角色
如要擷取開發人員角色,請向機構/{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 |
開發人員角色的名稱。 |
不適用 | 是 |
description |
開發人員角色的說明, |
不適用 | 是 |
使用 API 擷取開發人員的稅率
您可向開發人員提出 GET 要求,以取得開發人員目前的稅率
organizations/{org_name}/tax-engine
。發出要求時,您需要指定
要識別開發人員做為查詢參數例如:
$ 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 套件 | |
建立開發人員費率方案 | |
查看開發人員適用的費率方案 | |
查看費率方案,適用於包含特定供應商 產品 | |
只查看已接受的開發人員費率方案 | |
核發抵免額給開發人員 | |
為開發人員設定信用額度 | |
查看開發人員信用額度 | |
「儲值」(儲值) 開發人員的預付餘額 | |
查看開發人員的預付餘額 | |
為開發人員設定通知條件 | |
建立及查看開發人員的報表定義 |