管理機構資料

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

以下各節將介紹機構設定檔，並說明如何使用使用者介面和API管理設定檔。

關於機構資料

在初始營利設定中，Apigee Edge 設定團隊會設定機構設定檔。

您需要編輯機構設定檔，視需要新增或更新貴機構的相關資訊。 舉例來說，您可能需要更新帳單類型、幣別設定或稅務模式。

設定貴機構的基本資訊，包括：

  • 機構名稱、地址和營運國家/地區
  • 如「瞭解帳單類型」一節所述，帳單類型 (預付、後付或兩者皆是)
  • 帳單週期 (按比例計算或日曆月)
  • 基本貨幣
  • 貴機構使用的稅務模式

您可以使用使用者介面和API管理機構設定檔，詳情請參閱下文。

探索「機構資料」頁面

請按照下方說明前往「機構個人資料」頁面。

Edge

如何使用 Edge UI 存取「機構付款資料」頁面：

  1. 登入 apigee.com/edge。
  2. 在左側導覽列中，依序選取「發布」>「營利」>「機構設定檔」。

系統會顯示「機構簡介」頁面。

如圖所示，機構設定檔頁面可讓您執行下列操作：

  • 查看目前的機構設定檔設定
  • 編輯機構檔案設定，包括：

Classic Edge (Private Cloud)

如要使用傳統 Edge UI 存取「機構」頁面，請按照下列步驟操作：

  1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 IP 位址或 DNS 名稱。
  2. 在頂端導覽列中，依序選取「管理」>「機構設定檔」。

系統會顯示「機構簡介」頁面。

您可以在「機構付款資料」頁面中執行以下操作：

  • 查看目前的機構設定檔設定
  • 編輯機構檔案設定，包括：

使用 UI 編輯機構設定檔

如要使用使用者介面編輯機構檔案，請按照下列步驟操作：

  1. 前往「機構設定檔」頁面。
  2. 按一下 [編輯]。
  3. 在「名稱和資訊」下方，編輯機構名稱和營運國家/地區。
  4. 在「稅金和幣別」下方，編輯下列欄位：
    欄位 說明
    稅務模式

    注意：僅適用於已設定收益分潤費率方案，且想產生帳單文件的情況。

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

    有效值包括：

    • 已揭露：API 供應商會擔任開發人員的揭露代理人。從使用者收取的毛收益 (含銷售稅) 會轉交給開發人員。API 供應商會以佣金發票的形式向開發人員收取佣金。API 供應商不會處理向使用者收取的營業稅，開發人員有責任回報營業稅。
    • 未揭露：API 供應商會擔任開發人員的未揭露代理人，從使用者身上收取稅金，並將稅金支付給當地稅務機關。開發人員會向 API 供應商開立帳單，列出開發人員應得的淨收益分潤 (扣除銷售稅和 API 供應商的佣金)。
    • 混合型：API 供應商會擔任開發人員的公開代理人。不過，API 供應商會代替開發人員向當地稅務機關支付從訂閱者收取的營業稅。API 供應商會將剩餘的收益轉交給開發人員，然後開立佣金費用的帳單。
    幣別

    貴機構支援的貨幣。對於收益分潤、費率表和僅收費方案，系統會使用預設貨幣。建立費率表或僅收費方案時，您可以從支援的貨幣清單中選取，變更要使用的貨幣。您可以選擇為每種幣別設定應用程式開發人員可為預付帳戶餘額儲值的最低金額。

    如何新增貨幣：

    1. 按一下「新增貨幣」。
    2. 在「Currency」欄位的下拉式選單中選取幣別。
    3. 您可以選擇在「最低儲值金額」欄位中，設定應用程式開發人員可在指定幣別中為預付帳戶餘額儲值的最低金額。
    4. 按一下 [新增]。
    5. 如要將其設為預設幣別，請按一下相關聯的圓形按鈕。
    6. 如要新增其他幣別，請重複上述步驟。

    如要刪除貨幣，請將滑鼠游標懸停在要刪除的貨幣上，然後按一下 。
  5. 管理條款及細則，如「使用 UI 管理條款及細則」一文所述。
  6. 按一下 [儲存]。

使用 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 更新為 USD，並將稅金模型設定為 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。在這種情況下，您可以使用 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 供應商開立帳單。這個值可以是下列任一項目：

  • true：產生自付月費的帳單，而非收益分潤報表。
  • false：停用自結帳月結單。
 不適用 否
hasSeparateInvoiceForProduct

旗標，用於指定是否為每項 API 產品產生單獨的月結單。值可以是下列任一項目：

  • true：系統會為每項 API 產品產生個別的月結單。
  • false：系統不會為每項 API 產品產生單獨月結單。
 不適用 否
id

機構 ID。

 不適用 否
issueNettingStmt

標記，用於指定在建立帳單文件時是否產生對帳單。這個值可以是下列任一項目：

  • true：建立帳單文件時會產生對沖報表。
  • false：建立帳單文件時不會產生對沖報表。
 不適用 否
logoUrl

機構標誌的網址。

 不適用 否
name

機構名稱。

 不適用 是
netPaymentAdviceNote

淨付款通知單。

 不適用 否
nettingStmtPerCurrency

旗標，用於指定系統是否會針對每個使用的貨幣產生個別的對沖報表。這個值可以是下列任一項目：

  • true：系統會針對每種使用的貨幣產生個別的對沖報表。
  • false：系統不會針對每個使用的貨幣產生個別的對帳單。
 不適用 否
regNo

機構登記號碼。您為這項資源輸入的數字會顯示在帳單文件底部。

 不適用 否
selfBillingAsExchOrg

如果已啟用自結帳月結單，則表示該月結單是否已啟用交換機構。這個值可以是下列任一項目：

  • true：已為廣告交易平台機構啟用自付月結單。
  • false：交換機構不支援自行開立帳單的月結單。
 不適用 否
selfBillingForAllDev

如果已啟用自付月費的月結單，請指出是否已為所有應用程式開發人員啟用這項功能。根據預設，系統只會為已與 API 供應商簽署協議的應用程式開發人員產生自付款月結單。這個值可以是下列任一項目：

  • true：所有應用程式開發人員都已啟用自行結算的月結單。
  • false：並非所有應用程式開發人員都能啟用自付月結單。
 false 否
separateInvoiceForFees

標記，用於指定是否要針對費用發出個別月結單。值可以是下列任一項目：

  • true：系統會針對費用發出個別月結單。
  • false：系統不會針對費用發出單獨月結單。
 false 是
status

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

  • 有效：機構帳戶已註冊營利功能，可供使用。
  • 未啟用：機構帳戶已註冊營利功能，但無法使用。
 不適用 否
supportedBillingType

用於結帳的開發人員付款模式。這個值可以是下列其中一個：

  • PREPAID：開發人員預先支付 API 產品的使用費用。使用 API 產品時，系統會從開發人員的餘額扣款。開發人員必須維持足夠的預付款餘額，才能購買 API 產品。
  • POSTPAID：開發人員每月 (透過月結單) 支付 API 產品的費用。開發人員會根據帳單中所附方案設定的付款條件，支付使用 API 產品的費用。
  • BOTH：支援任一帳單類型。預設值為 PREPAID。

請參閱「使用 API 設定預付和後付結帳類型」。

PREPAID 是
taxModel

注意：只有在您設定收益分潤費率方案，且想產生帳單文件時才適用。

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

有效值包括：

  • 已揭露：API 供應商會擔任開發人員的揭露代理人。從使用者收取的毛收益 (含銷售稅) 會轉交給開發人員。API 供應商會以佣金發票的形式向開發人員收取佣金。API 供應商不會處理向使用者收取的營業稅，開發人員有責任回報營業稅。
  • 未揭露：API 供應商會擔任開發人員的未揭露代理人，從使用者身上收取稅金，並將稅金支付給當地稅務機關。開發人員會向 API 供應商開立帳單，列出開發人員應得的淨收益分潤 (扣除銷售稅和 API 供應商的佣金)。
  • 混合型：API 供應商會擔任開發人員的公開代理人。不過，API 供應商會代替開發人員向當地稅務機關支付從訂閱者收取的營業稅。API 供應商會將剩餘的收益轉交給開發人員，然後開立佣金費用的帳單。
 不適用 是
taxNexus

貴機構為稅務目的登記的國家/地區。

 不適用 否
taxRegNo

機構的稅務登記號碼或加值稅 (VAT) 登記號碼 (如適用)。稅務註冊編號或加值稅註冊編號並非適用於所有國家/地區，因此這個屬性為選用屬性。您為這個參數輸入的數字會顯示在帳單文件底部。

 不適用 否
transactionRelayURL

可轉送交易的其他系統網址，例如資料倉儲。

 不適用 否
timezone

組織營運的時區 ID，例如美國/紐約或歐洲/巴黎。系統也支援時區縮寫，例如 UTC、EST (美國東部標準時間) 或 CET (中歐時間)。

 不適用 是

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

使用 UI 或 API 覆寫公司或應用程式開發人員的營利設定檔，詳情請參閱以下各節：