管理機構資料

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

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

關於機構資料

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

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

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

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

如要使用 UI 和 API 管理機構設定檔，請參閱下列各節。

探索「機構付款資料」頁面

存取機構設定檔頁面，詳情請見下方說明。

邊緣

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

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

系統會顯示「機構設定檔」頁面。

如圖所示，「組織設定檔」頁面可讓您：

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

Classic Edge (Private Cloud)

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

  1. 登入 http://ms-ip:9000，其中 ms-ip 是管理伺服器節點的 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. 如「透過使用者介面管理條款及細則」一文所述，管理條款及細則。
  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 更新為美元，並將稅務模型設定更新為 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

機構地址，可包含街道地址、城市、州/省、郵遞區號、國家/地區，以及這是否為機構的主要地址。

 N/A 否
approveTrusted

這個標記不會使用。

 N/A 否
approveUntrusted

這個標記不會使用。

 N/A 否
billingCycle

帳單週期。可能的值如下：

  • 按比例計費：系統會根據 API 產品在日曆月份中的使用天數計費。
  • CALENDAR_MONTH：按月計費。

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

N/A 是
country

機構營運所在國家/地區的 ISO 3166-2 代碼，例如巴西的代碼為 BR。

 N/A 是
currency

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

收益分潤方案：系統會使用您指定的幣別。

費率表 (收費模式) 方案：適用與收益分享方案相同的規定。不過，您可以將幣別設定變更為機構支援的任何幣別。

僅收取費用的方案：您可以將幣別設定變更為機構支援的任何幣別。

 N/A 是
description

機構的簡短說明。

 N/A 否
hasBillingAdjustment

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

  • true：已啟用調整項。
  • false：未啟用調整項。
 N/A 否
hasBroker

指定收益是否以淨額為準的旗標。值可以是下列任一選項：

  • true：收益是根據淨利計算。
  • false：收益並非以淨額為準。
 N/A 否
hasSelfBilling

這項標記會指示營利功能產生自結帳單，而非收益分潤對帳單。自結發票是財務文件，詳細列出應付給應用程式開發人員的金額。這份文件會代表應用程式開發人員，向 API 供應商開立發票。這個值可以是下列任一項目：

  • true：產生自結發票，而非收益分潤對帳單。
  • false：停用自結月結單。
 N/A 否
hasSeparateInvoiceForProduct

這個旗標會指定是否要為每個 API 產品產生個別月結單。這個值可以是下列任一項目：

  • true：系統會為每個 API 產品產生個別的月結單。
  • false：不會為每個 API 產品產生個別月結單。
 N/A 否
id

機構 ID。

 N/A 否
issueNettingStmt

此旗標會指定在建立帳單文件時，是否要產生結算單。這個值可以是下列任一項目：

  • true：建立帳單文件時，系統會產生結算單。
  • false：建立帳單文件時不會產生結算單。
 N/A 否
logoUrl

機構標誌的網址。

 N/A 否
name

機構名稱。

 N/A 是
netPaymentAdviceNote

淨付款建議附註。

 N/A 否
nettingStmtPerCurrency

這個旗標會指定是否為使用的每種貨幣產生個別的結算單。這個值可以是下列任一項目：

  • true：系統會為使用的每種貨幣產生個別的結算單。
  • false：不會為使用的每種貨幣產生個別的結算單。
 N/A 否
regNo

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

 N/A 否
selfBillingAsExchOrg

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

  • true：為廣告交易平台機構啟用自結帳單。
  • false：交換機構未啟用自結帳單。
 N/A 否
selfBillingForAllDev

如果啟用自行結算月結單，則表示是否為所有應用程式開發人員啟用。根據預設，只有與 API 供應商簽署協議的應用程式開發人員，才會收到自結月結單。這個值可以是下列任一項目：

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

這個旗標會指定是否要另外發布費用月結單。這個值可以是下列任一選項：

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

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

  • 有效：機構帳戶已註冊營利功能，可供使用。
  • 無效：機構帳戶已註冊營利功能，但無法使用。
 N/A 否
supportedBillingType

用於帳單的開發人員付款模式。可能的值如下：

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

請參閱「使用 API 設定預付和後付型計費方式」。

預付 是
taxModel

注意：只有在設定收益分潤費率方案，且想產生帳單文件時，才需要執行這項操作。

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

有效值包括：

  • 已揭露：API 提供者是開發人員的已揭露代理人。向使用者收取的總收益 (包括銷售稅) 會轉給開發人員。我們會向開發人員收取 API 提供者的佣金，並開立佣金發票。API 供應商不會處理向使用者收取的營業稅，開發人員有責任回報營業稅。
  • 未揭露：API 供應商是開發人員的未揭露代理人，會扣除向使用者收取的稅金，並支付給當地稅務機關。開發人員會向 API 供應商開立發票，收取應付給開發人員的淨收益分潤 (扣除銷售稅和 API 供應商的佣金)。
  • 混合式：API 提供者是開發人員的揭露代理人。不過，API 供應商會代表開發人員，將向訂閱者收取的營業稅繳交給當地稅務機關。API 供應商會將剩餘收益轉給開發人員，然後開立佣金費用發票。
 N/A 是
taxNexus

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

 N/A 否
taxRegNo

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

 N/A 否
transactionRelayURL

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

 N/A 否
timezone

機構營運時區的 ID，例如 America/New_York 或 Europe/Paris。系統也支援時區縮寫，例如 UTC、EST (東部標準時間) 或 CET (中歐時間)。

 N/A 是

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

使用使用者介面或 API 覆寫公司或應用程式開發人員的營利設定檔設定，詳情請參閱下列章節：