Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご覧ください。
以下のセクションでは、組織プロファイルについて説明し、UI と API を使用して組織プロファイルを管理する方法について説明します。
組織プロフィールについて
収益化の初期設定の一環として、Apigee Edge 構成チームが組織のプロファイルを設定します。
必要に応じて、組織プロフィールを編集し、組織に関する情報を追加または更新する必要があります。たとえば、請求タイプ、通貨の設定、税金モデルの更新が必要になる場合があります。
組織に関する以下のような基本情報を構成します。
- 組織名、住所、運営国
- 請求タイプ(プリペイド、後払い、またはその両方を参照)
- 請求期間(日割りまたは月単位)
- 基本通貨
- 組織で使用されている税モデル
以降のセクションで説明するように、UI と API を使用して組織プロファイルを管理できます。
組織プロフィール ページを探索する
下記の説明に沿って、[組織プロフィール] ページにアクセスします。
エッジ
Edge UI を使用して [Organization Profile] ページにアクセスするには:
- apigee.com/edge にログインします。
- 左側のナビゲーション バーで [Publish] > [Monetization] > [Organization Profile] を選択します。
[Organization Profile] ページが表示されます。
図に示すように、[Organization Profile] ページでは次のことができます。
Classic Edge(プライベート クラウド)
Classic Edge UI を使用して [Organization Profile] ページにアクセスするには:
http://ms-ip:9000
にログインします。ms-ip は、Management Server ノードの IP アドレスまたは DNS 名です。- 上部のナビゲーション バーで [Admin] > [Organization Profile] を選択します。
[Organization Profile] ページが表示されます。
[組織プロフィール] ページでは、次のことができます。
UI を使用して組織プロファイルを編集する
UI を使用して組織プロファイルを編集するには:
- [組織プロフィール] ページにアクセスします。
- [編集] をクリックします。
- [名前と情報] で、組織名と事業拠点の国を編集します。
- [税金と通貨] で次の項目を編集します。
Field 説明 税モデル 注: 収益分配料金プランを設定し、請求ドキュメントを生成する場合にのみ適用されます。
必要な請求書類の種類を識別する、収益分配プランの税金モデル。
有効な値は次のとおりです。
- 開示: 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
: 請求は、1 か月のうちに 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 を使用して次の構成プロパティを設定できます。
Name | 説明 | デフォルト | 必須 / 任意 |
---|---|---|---|
address |
組織の住所。番地、市区町村、都道府県、郵便番号、国、および組織のメインの住所かどうかを指定できます。 |
なし | × |
approveTrusted |
このフラグは使用されません。 |
なし | × |
approveUntrusted |
このフラグは使用されません。 |
なし | × |
billingCycle |
請求期間。次のいずれかの値を指定できます。
API を使用した請求期間の構成をご覧ください。 |
なし | ○ |
country |
組織の営業対象国の ISO 3166-2 コード(ブラジルの BR など)。 |
なし | ○ |
currency |
ISO 4217 コード。組織が使用する「基本」または「会計」の通貨(米国ドルは「USD」など)。 収益分配プランの場合: 指定した通貨がプランに使用されます。 料金プラン(料金モデル)プラン: 収益分配プランの場合と同様です。通貨設定は、組織でサポートされている任意の通貨に変更できます。 料金のみのプランの場合: 通貨の設定は、組織でサポートされている任意の通貨に変更できます。 |
なし | ○ |
description |
組織の簡単な説明。 |
なし | × |
hasBillingAdjustment |
調整を有効にするかどうかを指定するフラグ。有効にすると、API プロダクトで API サービスによって記録されるトラフィックの詳細を調整できます。値は次のいずれかです。
|
なし | × |
hasBroker |
収益が純額に基づいているかどうかを指定するフラグ。値は次のいずれかになります。
|
なし | × |
hasSelfBilling |
収益分配ステートメントではなく自己請求請求書を生成するように収益化を指示するフラグ。自己請求書は、アプリ デベロッパーに支払う金額が記載された財務ドキュメントです。これは、アプリ デベロッパーに代わって API プロバイダへの請求書として機能します。次のいずれかの値を指定できます。
|
なし | × |
hasSeparateInvoiceForProduct |
API プロダクトごとに個別の請求書を生成するかどうかを指定するフラグ。次のいずれかの値を指定できます。
|
なし | × |
id |
組織の ID。 |
なし | × |
issueNettingStmt |
請求ドキュメントの作成時にネット ステートメントを生成するかどうかを指定するフラグ。次のいずれかの値を指定できます。
|
なし | × |
logoUrl |
組織のロゴの URL。 |
なし | × |
name |
組織の名前。 |
なし | ○ |
netPaymentAdviceNote |
実際の支払い額に関する注意事項。 |
なし | × |
nettingStmtPerCurrency |
使用する通貨ごとに個別の net ステートメントを生成するかどうかを指定するフラグ。次のいずれかの値を指定できます。
|
なし | × |
regNo |
組織の登録番号。このプロパティに入力した番号は、請求書の下部に表示されます。 |
なし | × |
selfBillingAsExchOrg |
自己請求書が有効な場合は、エクスチェンジ組織に対して有効になっているかどうかを示します。次のいずれかの値を指定できます。
|
なし | × |
selfBillingForAllDev |
請求書の自動作成機能が有効になっている場合は、すべてのアプリ デベロッパーの請求書が有効かどうかを示します。デフォルトでは、自己請求書は API プロバイダと契約を結んでいるアプリ デベロッパーにのみ生成されます。次のいずれかの値を指定できます。
|
false | × |
separateInvoiceForFees |
手数料として個別の請求書を公開するかどうかを指定するフラグ。次のいずれかの値を指定できます。
|
false | ○ |
status |
組織のステータス。有効な値は次のとおりです。
|
なし | × |
supportedBillingType |
請求に使用されるデベロッパーの支払いモデル。次のいずれかの値を指定できます。
API を使用したプリペイドと後払いの課金タイプの構成をご覧ください。 |
前払い | ○ |
taxModel |
注: 収益分配料金プランを設定し、請求ドキュメントを生成する場合にのみ適用されます。 必要な請求書類の種類を識別する、収益分配プランの税金モデル。 有効な値は次のとおりです。
|
なし | ○ |
taxNexus |
組織が税務上の目的で登録されている国。 |
なし | × |
taxRegNo |
組織の税務登録番号または付加価値税(VAT)登録番号(該当する場合)。納税者番号または VAT 登録番号は一部の国では適用されないため、このプロパティは省略可能です。このパラメータに入力した番号は、課金ドキュメントの下部に表示されます。 |
なし | × |
transactionRelayURL |
トランザクションを中継できる別のシステム(データ ウェアハウスなど)の URL。 |
なし | × |
timezone |
America/New_York、Europe/Paris など、組織のオペレーションのタイムゾーン ID。UTC、EST(東部標準時)、CET(中央ヨーロッパ時間)などのタイムゾーンの略称もサポートされています。 |
なし | ○ |
企業またはアプリ デベロッパーの収益化プロファイル設定をオーバーライドする
次のセクションで説明するように、UI または API を使用して企業またはアプリ デベロッパーの収益化プロファイルの設定をオーバーライドする。