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