您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
如要進一步控管參與營利 API 計畫的公司和開發人員 (例如打造用於測試的內部公司和開發人員),可以使用管理 UI 和 API 手動建立公司和開發人員。
判斷是否需要手動建立公司和開發人員,主要考量為判斷開發人員是否需要憑證才能登入管理 UI、在呼叫 Edge Management API 時傳送憑證,或是登入開發人員入口網站。
- 如果營利開發人員需要登入憑證才能存取 Edge UI 或 API,就必須先擁有自己的 Apigee 管理員帳戶。
- 如果您只想建立不需要憑證的測試開發人員 (例如當您想與虛構的測試開發人員進行 API 呼叫時),就不需要使用 Apigee 帳戶。
透過使用者介面管理應用程式開發人員
按照管理應用程式開發人員一文的說明,使用 Edge UI 建立、管理及啟用應用程式開發人員。建立應用程式開發人員後,您可以依照下列各節所述的方式將開發人員加入公司。
運用使用者介面管理公司
按照以下各節所述的方式建立、管理及啟用公司。
探索「公司」頁面
按照下文說明存取「公司」頁面。
Edge
如何透過 Edge UI 存取「公司」頁面:
- 登入 apigee.com/edge。
- 在左側導覽列中,依序選取「發布」>「營利」>「公司」。
系統隨即會顯示「公司」頁面。
如上圖所示,「公司」頁面可讓您:
傳統邊緣 (Private Cloud)
如何透過傳統版 Edge UI 存取「公司」頁面:
- 登入
http://ms-ip:9000
,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。 - 在頂端導覽列中,依序選取「發布」>「公司」。
系統隨即會顯示「公司」頁面。
- 查看目前的公司清單
- 管理公司特別新增、啟用、編輯及刪除公司。
- 查看已連結的開發人員入口網站 (僅限 Drupal 7)
新增公司
如要新增公司,請按照下列步驟操作:
- 存取「公司」頁面。
- 按一下「+ 公司」。
- 輸入公司詳細資料。
必填欄位包括:
- 公司名稱
- 管理員 (是主要公司管理員的使用者)
- 帳單類型
視營利帳單設定而定,帳單類型可能會預設為
PREPAID
或POSTPAID
。詳情請參閱使用 API 設定預付和後付帳單類型。 - 為公司新增一或多位開發人員。
- 在「Developer」(開發人員) 部分的「Add Developer」(新增開發人員) 欄位中輸入字串,顯示符合該字串的開發人員清單。
- 從下拉式清單中選取開發人員。
- 重複上述步驟,將其他開發人員加入公司。
- 新增一或多個自訂屬性。
- 在「自訂屬性」部分,按一下「+ 新增」。
- 輸入自訂屬性的名稱和值。
- 重複上述步驟,為公司新增其他自訂屬性。
- 按一下「建立公司」。
啟用及停用公司
啟用及停用公司的步驟如下:
- 存取公司頁面。
- 將遊標移到要啟用的公司上,並在動作選單中啟用 。
停用切換按鈕即可停用公司。
編輯公司
若要編輯公司:
- 存取公司頁面。
- 將遊標移到要修改的公司,然後按一下動作選單中的 。
- 視需要更新公司詳細資料。
- 按一下「更新公司」來儲存變更。
刪除公司
刪除公司的步驟如下:
- 存取「公司」頁面。
- 將遊標移到要刪除的公司上,然後按一下動作選單中的 。
- 按一下「刪除」來確認刪除作業。
使用 API 管理公司和開發人員
以下各節將說明如何使用 API 管理公司和開發人員。
使用 API 建立及更新公司和開發人員
如要使用 API Edge Management API 管理公司和開發人員,請參閱下列 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
正在擷取開發人員角色
如要擷取開發人員角色,請向機構/{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 擷取開發人員的稅率
你可以向 organizations/{org_name}/tax-engine
發出 GET 要求,取得開發人員目前的稅率。提出要求時,您必須將開發人員的身分指定為查詢參數。例如:
$ 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 套件 | |
建立開發人員費率方案 | |
查看開發人員可用的房價方案 | |
查看提供特定產品的特定開發人員適用的費率方案 | |
僅查看已接受的開發人員費率方案 | |
向開發人員核發抵免額 | |
為開發人員設定信用額度 | |
查看開發人員信用額度 | |
「儲值」(加入金額) 開發人員的預付餘額 | |
查看開發人員的預付餘額 | |
為開發人員設定通知條件 | |
建立及查看開發人員的報表定義 |