管理组织资料

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

以下部分介绍了组织资料，并说明了如何使用界面和 API 对其进行管理。

组织资料简介

在创收初始设置中，Apigee Edge 配置团队会设置您的组织资料。

您需要修改组织资料，以根据需要添加或更新有关您组织的信息。 例如，您可能需要更新结算类型、币种设置或税费模式。

配置贵组织的基本信息，包括：

  • 组织名称、地址和运营所在国家/地区
  • 结算类型（预付费和/或后付费），如了解结算类型中所述
  • 结算周期（按比例分摊或日历月）
  • 基本货币
  • 贵组织使用的税费模式

您可以使用界面和 API 管理您的组织资料，如以下部分所述。

浏览“组织资料”页面

按照下文所述访问“组织资料”页面。

Edge

如需使用 Edge 界面访问“组织资料”页面，请执行以下操作：

  1. 登录 apigee.com/edge。
  2. 在左侧导航栏中，依次选择发布 > 创收 > 组织资料。

系统随即会显示“组织资料”页面。

如图所示，在“组织资料”页面，您可以执行以下操作：

  • 查看当前的组织资料设置
  • 修改组织资料设置，包括：

传统 Edge (Private Cloud)

如需使用传统版 Edge 界面访问“组织资料”页面，请执行以下操作：

  1. 登录 http://ms-ip:9000，其中 ms-ip 是管理服务器节点的 IP 地址或 DNS 名称。
  2. 在顶部导航栏中依次选择管理 > 组织资料。

系统随即会显示“组织资料”页面。

在“组织资料”页面中，您可以执行以下操作：

  • 查看当前的组织资料设置
  • 修改组织资料设置，包括：

使用界面修改组织资料

如需使用界面修改组织资料，请执行以下操作：

  1. 访问“组织资料”页面。
  2. 点击修改。
  3. 在名称和信息下方，修改组织名称和运营所在国家/地区。
  4. 在税费和币种下，修改以下字段：
    字段 说明
    税费模式

    注意：仅适用于设置了收益分成费率方案并想要生成结算凭证时。

    收益分成费率方案的税种，用于标识所需的结算凭证类型。

    有效值包括：

    • 已披露：API 提供方充当开发者的已披露代理。从最终用户处收取的总收入（包括销售税）会转嫁给开发者。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 更新为 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 产品在一个日历月内使用的天数进行结算。
  • CAMPAIGNS_MONTH：结算每月进行一次。

请参阅使用 API 配置结算周期。

不适用 是
country

组织运营所在国家/地区的 ISO 3166-2 代码，如 BR 表示巴西。

 不适用 是
currency

组织使用的“基本”货币或会计货币的 ISO 4217 代码（例如 USD 代表美元）。

对于收益分成方案：指定的币种用于您的方案。

对于价目表（收费模式）方案：与收益分成方案相同。不过，您可以将币种设置更改为该组织支持的任何币种。

对于仅收费方案：您可以将币种设置更改为组织支持的任何币种。

 不适用 是
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

如果已启用自结算账单，请指明是否为 Exchange 组织启用了该功能。其值可以是以下两者之一：

  • true：为广告交易平台组织启用自行结算账单。
  • false：未为广告交易平台组织启用自行结算账单功能。
 不适用 否
selfBillingForAllDev

如果启用了自结算账单，请指明是否为所有应用开发者启用了该功能。默认情况下，系统只会为已与 API 提供方签署协议的应用开发者生成自结算账单。其值可以是以下两者之一：

  • true：已为所有应用开发者启用自行结算账单功能。
  • false：系统并未为所有应用开发者启用自行结算账单功能。
 false 否
separateInvoiceForFees

此标记用于指定是否针对费用发布单独的账单。其值可以是以下两者之一：

  • true：针对费用发布单独的账单。
  • false：不会针对费用单独发布账单。
 false 是
status

组织的状态。有效值包括：

  • 有效：组织帐号已注册创收功能，并可供使用。
  • INACTIVE（无效）：组织账号已注册用于创收，但无法使用。
 不适用 否
supportedBillingType

用于结算的开发者付款模式。可以是以下值之一：

  • 预付费：开发者预先付费才能使用 API 产品。使用 API 产品时，系统会从开发者的余额中扣除相应款项。开发者必须保持足以购买 API 产品的预付款余额。
  • POSTPAID：开发者按月（通过账单）结算 API 产品的使用费用。开发者根据账单中所含方案设置的付款期限支付 API 产品的使用费。
  • BOTH：支持任一结算类型。默认为 PREPAID。

请参阅使用 API 配置预付费和后付费结算类型。

预付费 是
taxModel

注意：仅适用于设置了收益分成费率方案并想要生成结算凭证时。

收益分成费率方案的税种，用于标识所需的结算凭证类型。

有效值包括：

  • 已披露：API 提供方充当开发者的已披露代理。从最终用户处收取的总收入（包括销售税）会转嫁给开发者。API 提供方的佣金以佣金账单的形式从开发者那里收取。API 提供商不负责处理向最终用户收取的销售税，开发者应负责申报销售税。
  • 未披露：API 提供方充当未披露的开发者代理，会扣减从最终用户处收取的税费，然后支付给当地税务机关。开发者向 API 提供商开具应向 API 提供商支付的净收益分成（减去销售税和 API 提供商的佣金）。
  • 混合：API 提供方充当开发者的披露代理。但是，API 提供方会代表开发者向当地税务机关支付从订阅者处收取的销售税。API 提供商将剩余收入转给开发者，然后开具佣金费用账单。
 不适用 是
taxNexus

表示相应组织是在哪个国家/地区注册的，负责税务事宜。

 不适用 否
taxRegNo

组织的税务登记号或增值税 (VAT) 注册号（如适用）。此属性是可选的，因为税务登记号或增值税登记号并不适用于所有国家/地区。您为此参数输入的数字会显示在结算凭证底部。

 不适用 否
transactionRelayURL

可将事务中继到其他系统（例如数据仓库）的网址。

 不适用 否
timezone

组织运营的时区标识符，例如 America/New_York 或 Europe/Paris。也支持时区缩写，例如 UTC、EST（东部标准时间）或 CET（中欧时间）。

 不适用 是

替换公司或应用开发者的创收资料设置

使用界面或 API 替换公司或应用开发者的创收资料设置，如以下部分所述：