管理機構資料

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件
資訊

以下各節介紹機構設定檔,並說明如何使用 UIAPI 管理機構設定檔。

關於機構資料

在營利的初始設定過程中,Apigee Edge 設定團隊會設定您的機構設定檔。

您需要編輯機構資料,才能視情況新增或更新機構相關資訊。 舉例來說,您可能需要更新帳單類型、幣別設定或稅金模式。

設定貴機構的基本資訊,包括:

  • 機構名稱、地址和營業國家/地區
  • 帳單類型 (預付、後付或兩者兼具),詳情請見「瞭解帳單類型」一文
  • 帳單週期 (按比例計算或每月)
  • 基本貨幣
  • 貴機構使用的稅務模式

你可以使用 UIAPI 管理機構資料,詳情請參閱下列說明: 以下各節。

探索「機構資料」頁面

按照下文所述的方式存取「機構資料」頁面。

Edge

如要使用 Edge UI 存取機構設定檔頁面,請按照下列步驟操作:

  1. 登入 apigee.com/edge
  2. 選取「發布」>「發布」營利 >機構資料。

這樣就會開啟「機構資料」頁面。

如圖所示,「機構資料」頁面可讓您執行下列操作:

  • 查看目前的機構資料設定
  • 編輯機構資料設定,包括:

傳統版 Edge (Private Cloud)

如要使用傳統版 Edge UI 存取機構設定檔頁面,請按照下列步驟操作:

  1. 登入「http://ms-ip:9000」(ms-ip 為以下應用程式) Management Server 節點的 IP 位址或 DNS 名稱。
  2. 依序選取「管理員」>上方導覽列中的「機構資料」

這樣就會開啟「機構資料」頁面。

透過「機構資料」頁面,您可以:

  • 查看目前的機構資料設定
  • 編輯機構資料設定,包括:

透過 UI 編輯機構個人資料

如要透過 UI 編輯機構資料,請按照下列步驟操作:

  1. 前往「機構設定檔」頁面。
  2. 按一下 [編輯]
  3. 在「名稱和資訊」下方,編輯機構名稱和營業國家/地區。
  4. 在「稅金和貨幣」下方編輯下列欄位:
    欄位 說明
    稅款

    注意:只有在您設定了收益分潤費率方案,並想要這麼做時,您才能使用這個選項 才能產生帳單文件

    收益分潤費率方案的稅務模式,用於識別所需的帳單文件類型。

    有效值包括:

    • 已揭露:API 供應商是 開發人員。向使用者收取的總收益 (含銷售稅) 為 傳送給開發人員API 供應商的佣金是從 收取佣金帳單的開發人員。API 供應商不處理 向使用者收取的銷售稅,而開發人員需負責 申報銷售稅。
    • 未公開:API 供應商是未公開的代理 ,並扣除向使用者收取的稅金,並支付給 當地稅務機關。開發人員向 API 供應商開立淨收益 應付給開發人員 (扣除銷售稅和 API 供應商的 佣金)。
    • 混合型:API 供應商是 開發人員。不過,API 供應商仍須支付其銷售稅 訂閱者。API 供應商接著會將剩餘收益傳送給開發人員,然後再開立 佣金費用。
    幣別

    貴機構支援的幣別。針對收益分潤、價目表和僅限付費的方案: 費率方案會採用預設幣別。建立價目表或僅限付費的方案時,您可以將貨幣變更為 從支援的貨幣清單中選取「虛擬貨幣」您可以視需要設定最低儲值金額,讓應用程式開發人員在每個貨幣的預付帳戶餘額中加值。

    如何新增貨幣:

    1. 按一下「新增幣別」
    2. 在「貨幣」欄位的下拉式選單中選取貨幣。
    3. 視需求在「最低儲值」欄位中,設定應用程式開發人員能以指定貨幣儲值的最低金額。
    4. 按一下 [新增]。
    5. 視需要按一下對應的圓形按鈕,將貨幣設定為預設貨幣。
    6. 重複上述步驟,新增其他貨幣。

    如要刪除貨幣,請將遊標移至要刪除的貨幣上,然後按一下 []。

  5. 按照透過 UI 管理條款及細則的說明,管理條款及細則。
  6. 按一下 [儲存]

使用 API 管理機構資料

使用 API 管理機構個人資料,如以下各節所述。

使用 API 查看機構個人資料

向以下使用者發出 GET 要求,查看貴機構的個人資料: /mint/organizations/{org_name}。例如:

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 編輯機構個人資料

對機構設定檔發出 PUT 要求: /mint/organizations/{org_name}。編輯機構資料時,您需要指定 機構資料屬性,而不只是您正在編輯的資源。

如要編輯機構的預設幣別,請將 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 屬性設為 下列值來說明有效的計費類型:PREPAIDPOSTPAIDBOTH。如果將值設為 BOTH 當您新增應用程式開發人員或公司時,預設值為 PREPAID。在此情況下,您可以按照下列說明,使用 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 設定帳單週期

如要為貴機構設定帳單週期,請將 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 產品在服務中使用的天數計費。 月份。
  • calendar_MONTH:帳單每月結算。

請參閱使用 API 設定帳單週期

不適用
country

國家/地區的 ISO 3166-2 代碼 例如巴西的 BR

不適用
currency

「基本」的 ISO 4217 代碼或 機構使用的會計貨幣 (例如美國的美元代表美元) 美元)。

收益分潤方案:您的企劃書會使用您指定的幣別。

價目表 (收費模式) 方案:與收益分潤方案相同。 不過,您可以將貨幣設定改為 並根據貴機構的使命 價值觀和目標進行調整

僅限付費方案:您可以將幣別設定改為 機構。

不適用
description

機構組織的簡短說明。

不適用
hasBillingAdjustment

此標記用於指定是否啟用調整功能。啟用後 調整 API 服務為 API 產品記錄的流量詳細資料。 可以是下列任一值:

  • true:調整功能已啟用。
  • false:未啟用調整項。
不適用
hasBroker

用於指定收益是否以淨額為基準的標記。該值可以是 包括:

  • true:收益是以淨值計算。
  • false:收益不是依據淨值計算。
不適用
hasSelfBilling

標記指示營利,讓系統產生自我帳單 (而非收益) 分享聲明自我帳單月結單是一種財務文件,可詳細列出確切金額 。是用於代表 API 供應商 應用程式開發人員這個值可以是下列任一項:

  • 正確:產生自行結算月結單,而非收益分潤對帳單。
  • false:停用自行結算月結單。
不適用
hasSeparateInvoiceForProduct

此旗標可指定是否要為每個 API 產品產生個別月結單。 可以是下列任一值:

  • true:為每個 API 產品產生個別的發票。
  • false:系統不會為每個 API 產品產生個別的發票。
不適用
id

機構的 ID。

不適用
issueNettingStmt

此標記用於指定建立帳單時是否會產生淨額陳述式 文件。這個值可以是下列任一項:

  • true:建立帳單文件時會產生淨額對帳單。
  • false:建立帳單文件時不會產生淨額對帳單。
不適用
logoUrl

機構標誌的網址。

不適用
name

機構名稱。

不適用
netPaymentAdviceNote

淨付款建議注意事項。

不適用
nettingStmtPerCurrency

此標記可指定是否要針對各個項目產生個別的淨額陳述式 這個值可以是下列任一項:

  • true:系統會針對每種使用的貨幣分別產生淨額對帳單。
  • 否:系統不會針對每種貨幣產生個別的淨額對帳單。
不適用
regNo

機構的註冊編號。您為這項資源輸入的數字是 並顯示在帳單文件底部

不適用
selfBillingAsExchOrg

如果自行結算月結單已啟用,請指出是否已啟用廣告交易平台 員工只能在您的 Google Cloud 機構中存取資源 無法在其他機構存取資源這個值可以是下列任一項:

  • true:已為廣告交易平台機構啟用自助帳單發票。
  • false:不能為交易所組織機構啟用自助帳單發票。
不適用
selfBillingForAllDev

如果自行結算月結單已啟用,請指出是否已為所有月結單啟用此功能 應用程式開發人員根據預設,系統只會為符合以下條件的應用程式開發人員產生自行結算應付憑據 已與 API 供應商簽訂協議這個值可以是下列任一項:

  • true:所有應用程式開發人員已啟用自行結算月結單。
  • false:部分應用程式開發人員並未啟用自行結算帳單功能。
false
separateInvoiceForFees

用於指定是否發布其他月結單費用的旗標。此值可以是 下列任一項:

  • true:另外開立一份費用的發票。
  • 錯誤:未針對費用另外發布發票。
false
status

機構的狀態。有效值包括:

  • 有效:機構帳戶已註冊營利資格, 相關單位會如何運用資料,並讓他們覺得自己 獲得充分告知,且能夠針對該使用方式表示同意
  • 無效:機構帳戶已註冊營利設定,但未註冊 使用。
不適用
supportedBillingType

用於計費的開發人員付款方式。這可以是下列其中一個值:

  • 預付:開發人員必須預先支付 API 產品的使用費。資金為 已在使用 API 產品時從開發人員餘額中扣除。開發人員必須 您的預付餘額足以購買 API 產品。
  • POSTPAID:開發人員每個月必須支付 API 使用費 (透過月結單付費) 很少直接解答該如何打造產品開發人員會根據所設的付款條件支付 API 產品使用費 依據帳單所列方案而定
  • BOTH:支援任一計費類型。預設為 PREPAID。

請參閱使用 API 設定預付和後付計費類型

準備
taxModel

注意:只有在您設定了收益分潤費率方案,並想要這麼做時,您才能使用這個選項 才能產生帳單文件

收益分潤費率方案的稅務模式,用於識別所需的帳單文件類型。

有效值包括:

  • 已揭露:API 供應商是 開發人員。向使用者收取的總收益 (含銷售稅) 為 傳送給開發人員API 供應商的佣金是從 收取佣金帳單的開發人員。API 供應商不處理 向使用者收取的銷售稅,而開發人員需負責 申報銷售稅。
  • 未公開:API 供應商是未公開的代理 ,並扣除向使用者收取的稅金,並支付給 當地稅務機關。開發人員向 API 供應商開立淨收益 應付給開發人員 (扣除銷售稅和 API 供應商的 佣金)。
  • 混合型:API 供應商是 開發人員。不過,API 供應商仍須支付其銷售稅 訂閱者。API 供應商接著會將剩餘收益傳送給開發人員,然後再開立 佣金費用。
不適用
taxNexus

機構登記進行稅務登記的國家/地區。

不適用
taxRegNo

機構的稅務登記編號或加值稅 (VAT) 登記 編號 (如果有的話)。這個屬性是選用項目,因為稅務登記編號或 加值稅註冊編號不適用於所有國家/地區。您為這個活動輸入的編號 參數會顯示在帳單文件底部。

不適用
transactionRelayURL

可轉發交易的其他系統網址,例如資料 倉庫

不適用
timezone

機構營運作業的時區 ID,例如 America/New_York 或 Europe/Paris。時區縮寫,例如 UTC、EST (東部標準時間) 標準時間) 或 CET (中歐時間)。

不適用

覆寫公司或應用程式開發人員的營利設定檔設定

使用 UI 或 API 覆寫公司或應用程式開發人員的營利設定檔設定,如以下各節所述: