您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
以下各節介紹機構個人資料,並說明如何使用 UI 和 API 管理資料。
關於機構個人資料
在營利計畫的初始設定過程中,Apigee Edge 設定團隊會設定您的機構資料。
您必須視情況編輯機構資料,才能新增或更新機構相關資訊。 舉例來說,您可能需要更新帳單類型、貨幣設定或稅金模式。
設定貴機構的基本資訊,包括:
- 機構名稱、地址和營運國家/地區
- 帳單類型 (預付、後付或兩者皆是),詳情請參閱「瞭解帳單類型」一文
- 帳單週期 (按比例計費或按月收費)
- 基本幣別
- 貴機構使用的稅款模式
如以下各節所述,您可以使用 UI 和 API 管理機構設定檔。
瀏覽機構個人資料頁面
前往「機構個人資料」頁面 (如下所述)。
Edge
如何透過 Edge UI 存取「機構個人資料」頁面:
- 登入 apigee.com/edge。
- 在左側導覽列中,依序選取「發布」>「營利」>「機構資料」。
畫面上會顯示「機構個人資料」頁面。
如上圖所示,「機構個人資料」頁面可讓您:
傳統邊緣 (Private Cloud)
如何透過傳統版 Edge UI 存取「機構個人資料」頁面:
- 登入
http://ms-ip:9000
,其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。 - 在頂端導覽列中,依序選取「管理」>「機構設定檔」。
畫面上會顯示「機構個人資料」頁面。
您可以在「機構資料」頁面進行下列操作:
使用使用者介面編輯機構設定檔
如要透過使用者介面編輯機構設定檔,請按照下列步驟操作:
- 前往機構資料頁面。
- 按一下「編輯」。
- 在「名稱和資訊」下方,編輯機構名稱和營運國家/地區。
- 在「稅金和幣別」下方編輯下列欄位:
欄位 說明 稅金模式 注意:只有在設定收益分潤費率方案,且想產生帳單文件時,才能使用這個選項。
收益分潤費率方案的稅款模式,用於識別所需的帳單文件類型。
有效值包括:
- 揭露:API 供應商就像是開發人員的揭露代理程式。向使用者收取的總收益 (含銷售稅) 會傳送給開發人員。API 供應商的佣金會以佣金應付憑據的形式向開發人員收取。API 供應商不負責處理使用者收取的銷售稅,而是開發人員必須負責申報銷售稅。
- 明確揭露:API 供應商是對開發人員的保密代理人,扣除向使用者收取的稅金,並繳交給當地稅務機關。開發人員向 API 供應商開立應付憑據的淨收益分潤依據,由開發人員負責 (不含銷售稅和 API 供應商的佣金)。
- 混合型:API 供應商就像是開發人員的揭露代理程式。不過,API 供應商會代表開發人員,支付從訂閱者收取的銷售稅給當地稅務機關。API 供應商會將剩餘收益傳送給開發人員,然後收取佣金費用。
幣別 貴機構支援的貨幣單位。針對收益分潤、價目表和收費方案,您的費率方案會使用預設貨幣。當您建立價目表或僅限付費方案時,可以從支援的貨幣清單中選取,變更要使用的貨幣。或者,您也可以設定應用程式開發人員可以為各種幣別加值的最低儲值金額。
如何新增貨幣:
- 按一下「新增貨幣」。
- 在「貨幣」欄位的下拉式選單中選取幣別。
- 您也可以選擇在「最低儲值」欄位中,以指定幣別設定應用程式開發人員可加收預付帳戶餘額的最低金額。
- 按一下 [新增]。
- 視需要按一下相關的圓形按鈕,設為預設貨幣。
- 重複以上步驟即可新增其他幣別。
如要刪除貨幣,請將滑鼠遊標移至要刪除的貨幣上,然後按一下 。
- 管理條款及細則,詳情請參閱「透過 UI 管理條款及細則」。
- 點按「儲存」。
使用 API 管理機構設定檔
請按照下列各節所述,使用 API 管理機構設定檔。
使用 API 查看機構設定檔
向「/mint/organizations/{org_name}
」發出 GET 要求,即可查看您的機構資料。例如:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
以下提供回應範例。如要進一步瞭解顯示的選項,請參閱 API 的機構設定檔設定屬性。
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
使用 API 編輯機構設定檔
向 /mint/organizations/{org_name}
發出 PUT 要求,即可編輯機構設定檔。編輯機構設定檔時,您必須指定所有機構設定檔屬性,而不只是指定編輯的屬性。
如要編輯機構的預設貨幣,請將 currency
值設為您要設為預設貨幣的 ISO 4217 貨幣代碼。
舉例來說,下列 API 呼叫會將 currency
更新為美元,並將稅金模式設定更新為 HYBRID
(範例中會醒目顯示更新的欄位)。如要進一步瞭解顯示的選項,請參閱 API 的機構設定檔設定屬性。
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
使用 API 設定預付和後付帳單類型
開發人員帳戶可設為使用下列帳單類型:預付和/或後付。
使用預付帳戶時,開發人員需預先支付 API 的使用費。系統會從透過整合的付款服務供應商保存的開發人員預付餘額中扣除相應款項。 開發人員必須保留預付餘額,才能購買 API。
針對後付帳戶,開發人員會在月底按月透過月結單收費。 開發人員支付 API 產品使用費用時,會根據月結單載明的方案設定付費條件。
如要為貴機構設定預付和後付計費類型,請將 supportedBillingType
屬性設為下列其中一個值,指出有效的帳單類型:PREPAID
、POSTPAID
或 BOTH
。如果將值設為 BOTH
,則新增應用程式開發人員或公司時,預設值會是 PREPAID
。在此情況下,您可以按照管理公司和應用程式開發人員中的說明,為公司或應用程式開發人員明確設定帳單類型。
例如:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
使用 API 設定帳單週期
如要為貴機構設定帳單週期,請將 billingCycle
屬性設為下列其中一個值:
PRORATED
:帳單是依據 API 產品每月使用的天數計費。CALENDAR_MONTH
:帳單會按月處理。
例如:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
API 的機構設定檔設定屬性
透過機構設定檔,您可以使用 API 設定下列設定屬性。
名稱 | 說明 | 預設 | 必填與否 |
---|---|---|---|
address |
機構地址,包括街道地址、城市、州、郵遞區號、國家/地區,以及表明這是否為機構的主要地址。 |
不適用 | 否 |
approveTrusted |
系統未使用這個標記。 |
不適用 | 否 |
approveUntrusted |
系統未使用這個標記。 |
不適用 | 否 |
billingCycle |
帳單週期。這個值可以是下列其中一項:
請參閱使用 API 設定帳單週期。 |
不適用 | 是 |
country |
機構營運國家/地區的 ISO 3166-2 代碼,例如巴西的 BR。 |
不適用 | 是 |
currency |
以機構使用的「基準」或會計貨幣 (例如美元代表美元) 做為 ISO 4217 代碼。 針對收益分潤方案:企劃書會使用指定的幣別。 價目表 (收費模式) 方案:與收益分潤方案相同。不過,您可以將幣別設定變更為機構支援的任何貨幣。 僅限費用方案:您可以將幣別設定變更為機構支援的任何貨幣。 |
不適用 | 是 |
description |
機構的簡要說明。 |
不適用 | 否 |
hasBillingAdjustment |
此標記用於指定是否啟用調整項。啟用後,您就可以調整 API 服務為 API 產品記錄的流量詳細資料。這個值可以是下列任一值:
|
不適用 | 否 |
hasBroker |
此標記用於指定收益是否根據淨值。這個值可以是下列任一值:
|
不適用 | 否 |
hasSelfBilling |
引導營利內容產生自助帳單 (而非收益分潤聲明) 的檢舉。自助帳單應付憑據會詳細列出應用程式開發人員應付的金額。可以代表應用程式開發人員向 API 供應商開立的應付憑據。這個值可以是下列其中一項:
|
不適用 | 否 |
hasSeparateInvoiceForProduct |
此標記用於指定是否要為每個 API 產品產生個別發票。這個值可以是下列其中一項:
|
不適用 | 否 |
id |
機構 ID。 |
不適用 | 否 |
issueNettingStmt |
這個旗標用於指定在建立帳單文件時,是否會產生淨帳陳述式,這個值可以是下列其中一項:
|
不適用 | 否 |
logoUrl |
機構標誌的網址。 |
不適用 | 否 |
name |
機構名稱。 |
不適用 | 是 |
netPaymentAdviceNote |
淨付款建議。 |
不適用 | 否 |
nettingStmtPerCurrency |
此標記用於指定是否要為每個使用的貨幣產生個別的淨化陳述式。這個值可以是下列其中一項:
|
不適用 | 否 |
regNo |
機構登記編號。您為這項資源輸入的編號會顯示在帳單文件底部。 |
不適用 | 否 |
selfBillingAsExchOrg |
如果自助帳單月結單已啟用,表示廣告交易平台機構是否已啟用該功能。這個值可以是下列其中一項:
|
不適用 | 否 |
selfBillingForAllDev |
如果自助帳單月結單已啟用,請指出是否已為所有應用程式開發人員啟用該功能。根據預設,只有與 API 供應商簽署協議的應用程式開發人員,才會產生自助帳單月結單。這個值可以是下列其中一項:
|
false | 否 |
separateInvoiceForFees |
用於指定是否要發布另一份費用月結單的標記。這個值可以是下列其中一項:
|
false | 是 |
status |
機構的狀態。有效值包括:
|
不適用 | 否 |
supportedBillingType |
用於計費的開發人員付款模式。這個值可以是下列其中一項:
詳情請參閱使用 API 設定預付和後付帳單類型。 |
準備 | 是 |
taxModel |
注意:只有在設定收益分潤費率方案,且想產生帳單文件時,才能使用這個選項。 收益分潤費率方案的稅款模式,用於識別所需的帳單文件類型。 有效值包括:
|
不適用 | 是 |
taxNexus |
機構登記課稅時登記的國家/地區。 |
不適用 | 否 |
taxRegNo |
機構的稅務登記編號或加值稅 (VAT) 註冊編號 (如適用)。這是選填屬性,因為稅籍編號或加值稅註冊編號並不適用於所有國家/地區。您為這個參數輸入的數字會顯示在帳單文件底部。 |
不適用 | 否 |
transactionRelayURL |
可轉發交易的其他系統網址,例如資料倉儲。 |
不適用 | 否 |
timezone |
機構作業的時區 ID,例如 America/New_York 或 Europe/Paris。此外,也支援時區縮寫,例如 UTC、EST (東部標準時間) 或 CET (中歐時間)。 |
不適用 | 是 |
為公司或應用程式開發人員覆寫營利設定檔設定
透過 UI 或 API 覆寫公司或應用程式開發人員的營利設定檔設定,詳情請見以下各節: