このページは Cloud Translation API によって翻訳されました。

組織プロフィールを管理する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。情報

以降のセクションでは、組織プロファイルについて説明し、UI と API を使用して組織プロファイルを管理する方法について説明します。

組織プロファイルについて

収益化の初期設定の一環として、Apigee Edge 構成チームが組織プロファイルを設定します。

組織に関する情報を追加または更新するには、組織のプロフィールを編集する必要があります。たとえば、お支払いタイプ、通貨の設定、税金モデルの更新が必要になることがあります。

組織に関する基本情報を設定します。

組織名、住所、事業を行っている国
請求タイプ（前払い、後払い、またはその両方）: 請求タイプについてをご覧ください。
請求期間（案分または暦月）
ベース通貨
組織で使用している税務モデル

組織のプロファイルは、以降のセクションで説明するように、UI と API を使用して管理できます。

組織プロファイルページを探索する

次の手順で [組織のプロフィール] ページにアクセスします。

Edge

Edge UI を使用して [組織のプロフィール] ページにアクセスするには:

apigee.com/edge にログインします。
左側のナビゲーションバーで [公開] > [収益化] > [組織のプロフィール] を選択します。

[組織のプロフィール] ページが表示されます。

図でハイライト表示されているように、[組織のプロフィール] ページでは次のことができます。

現在の組織プロファイルの設定を表示する
組織プロファイルの設定を編集します。たとえば、次の設定を編集できます。
- 名前と情報
- 税金と通貨
- 利用規約（利用規約の管理を参照）

Classic Edge（Private Cloud）

Classic Edge UI を使用して [組織のプロフィール] ページにアクセスするには:

http://ms-ip:9000 にログインします。ms-ip は Management Server ノードの IP アドレスまたは DNS 名です。
上部のナビゲーションバーで [Admin] > [Organization Profile] を選択します。

[組織のプロフィール] ページが表示されます。

[組織のプロフィール] ページでは、次のことができます。

現在の組織プロファイルの設定を表示する
組織プロファイルの設定を編集します。たとえば、次のような設定を編集できます。
- 名前と情報
- 税金と通貨
- 利用規約（利用規約の管理を参照）

UI を使用して組織プロファイルを編集する

UI を使用して組織プロファイルを編集するには:

組織のプロフィールページにアクセスします。
[編集] をクリックします。
[名前と情報] で、組織名と事業拠点の国を編集します。

[税金と通貨] で、次のフィールドを編集します。

フィールド	説明
税金モデル	注: 収益分配料金プランを設定し、請求書類を生成する場合にのみ適用されます。収益分配料金プランの税務モデル。必要な請求書類の種類を特定します。有効な値は次のとおりです。開示済み: API プロバイダはデベロッパーの開示代理人として機能します。エンドユーザーから収集された総収益（消費税を含む）はデベロッパーに渡されます。API プロバイダのコミッションは、コミッション請求書の形でデベロッパーから徴収されます。API プロバイダは、エンドユーザーから収集した売上税を処理しません。売上税の報告はデベロッパーの責任となります。非開示: API プロバイダはデベロッパーの非開示代理人として機能し、エンドユーザーから収集した税金を控除して地方税務当局に支払います。デベロッパーは、デベロッパーに支払われる純収益分配額（売上税と API プロバイダの手数料を差し引いた額）を API プロバイダに請求します。ハイブリッド: API プロバイダはデベロッパーの開示代理人として機能します。ただし、API プロバイダは、契約者から集めた売上税をデベロッパーに代わって地方税務当局に支払います。API プロバイダは残りの収益をデベロッパーに渡し、コミッション料金を請求します。
通貨	組織でサポートされている通貨。収益分配、料金表、料金のみのプランでは、料金プランにデフォルトの通貨が使用されます。料金表または料金のみのプランを作成する際は、サポートされている通貨のリストから選択して、使用する通貨を変更できます。必要に応じて、アプリデベロッパーが前払いアカウントの残高に追加できる最低チャージ額を通貨ごとに設定できます。通貨を追加するには: [通貨を追加] をクリックします。 [通貨] フィールドのプルダウンメニューから通貨を選択します。必要に応じて、アプリデベロッパーが指定した通貨で前払いアカウントの残高に追加できる最小金額を [最小チャージ額] フィールドに設定します。 [追加] をクリックします。必要に応じて、関連するラジオボタンをクリックして、デフォルトの通貨として設定します。手順を繰り返して、追加の通貨を追加します。通貨を削除するには、削除する通貨にカーソルを合わせてをクリックします。警告: アプリデベロッパーまたは料金プランで使用されている通貨は削除できません。

フィールド

説明

税金モデル

注: 収益分配料金プランを設定し、請求書類を生成する場合にのみ適用されます。

収益分配料金プランの税務モデル。必要な請求書類の種類を特定します。

有効な値は次のとおりです。

開示済み: 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 を 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: 月単位で請求が行われます。