<ph type="x-smartling-placeholder"></ph>
現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細
以下のセクションでは、組織プロファイルの概要と、UI と API を使用して組織プロファイルを管理する方法について説明します。
組織のプロフィールについて
収益化の初期設定の一環として、Apigee Edge 構成チームが組織プロファイルを設定します。
必要に応じて、組織プロフィールを編集し、組織に関する情報を追加または更新する必要があります。 たとえば、請求タイプ、通貨の設定、税モデルなどを更新する必要がある場合があります。
次のような組織に関する基本情報を設定します。
- 組織名、住所、事業を行っている国
- 請求タイプ(前払い、後払い、またはその両方)については、請求タイプについてをご覧ください。
- 請求期間(日割り計算または暦月)
- 基本通貨
- 組織で使用している税モデル
組織プロファイルは、UI と API を使用して管理できます。詳しくは、 説明します。
[Organization Profile] ページにアクセスする
以下の手順に沿って [Organization Profile] ページにアクセスします。
Edge
Edge UI を使用して [Organization Profile] ページにアクセスするには:
- apigee.com/edge にログインします。
- [公開 >収益化 >組織のプロファイル] をクリックします。
[Organization Profile] ページが表示されます。
上の図に示すように、[Organization Profile] ページでは次のことができます。
Classic Edge(プライベート クラウド)
Classic Edge UI を使用して [Organization Profile] ページにアクセスするには:
http://ms-ip:9000
(ms-ip の部分)にログインします。 Management Server ノードの IP アドレスまたは DNS 名。- [管理 >組織のプロファイル] をクリックします。
[Organization Profile] ページが表示されます。
[Organization Profile] ページでは、次のことができます。
UI を使用して組織プロファイルを編集する
UI を使用して組織プロファイルを編集するには:
- [Organization Profile] ページにアクセスします。
- [編集] をクリックします。
- [名前と情報] で、組織名と事業を行う国を編集します。
- [税金と通貨] で次のフィールドを編集します。
フィールド 説明 税モデル 注: 収益分配の料金プランを設定し、 請求書を生成できます
必要な請求書類の種類を識別する、収益分配料金プランの税モデル。
有効な値は次のとおりです。
- 開示: API プロバイダは、 開発者です。エンドユーザーから徴収される総収益(消費税を含む)は次のとおりです。 渡されます。API プロバイダのコミッションは、 コミッション請求書の形で受け取りますAPI プロバイダは エンドユーザーから徴収される売上税(デベロッパーの責任です) 売上税をレポートします
- 未公表: API プロバイダは、 エンドユーザーから徴収された税金を差し引いて、 税務署ですデベロッパーが API プロバイダに純収益を請求する (売上税と API プロバイダの 。
- ハイブリッド: API プロバイダは、 開発者です。ただし、API プロバイダは、 地域の税務当局への登録者(デベロッパーの代わりに)API プロバイダが残りの収益をデベロッパーに渡し、 手数料が発生します
通貨 組織がサポートする通貨。収益分配率、レート表、料金プランのみの場合 デフォルトの通貨が料金プランで使用されますレート表または手数料のみのプランを作成する際、 使用できる通貨のリストから選択します。必要に応じて、アプリ デベロッパーが通貨ごとに前払い残高に追加できる最低チャージ額を設定できます。
通貨を追加するには:
- [通貨を追加] をクリックします。
- [通貨] フィールドのプルダウン メニューから通貨を選択します。
- 必要に応じて、[最低チャージ額] フィールドで、アプリ デベロッパーが指定の通貨で前払いアカウント残高に追加できる最低額を設定します。
- [追加] をクリックします。
- 必要な場合は、関連するラジオボタンをクリックして、デフォルトの通貨として設定します。
- さらに通貨を追加するには、上記の手順を繰り返します。
通貨を削除するには、削除する通貨にカーソルを合わせて [] をクリックします。
- UI を使用した利用規約の管理の説明に沿って、利用規約を管理します。
- [保存] をクリックします。
API を使用して組織プロファイルを管理する
ここでは、API を使用して組織プロファイルを管理する方法について説明します。
API を使用して組織プロファイルを表示する
組織のプロフィールを確認するには、次の宛先に GET リクエストを発行します。
/mint/organizations/{org_name}
。例:
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 を使用して組織プロファイルを編集する
組織プロファイルを編集するには、PUT リクエストを
/mint/organizations/{org_name}
。組織のプロファイルを編集する際は、すべての
組織プロファイルのプロパティに加え、編集中のプロパティだけでなく、
組織のデフォルトの通貨を編集するには、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 を使用して次の構成プロパティを設定できます。
名前 | 説明 | デフォルト | 必須 |
---|---|---|---|
address |
組織の住所(番地、市区町村、都道府県、郵便番号など) 国コード、国、この住所が できます。 |
なし | いいえ |
approveTrusted |
このフラグは使用されません。 |
なし | いいえ |
approveUntrusted |
このフラグは使用されません。 |
なし | いいえ |
billingCycle |
請求期間。値は次のいずれかになります。
API を使用して請求期間を設定するをご覧ください。 |
なし | ○ |
country |
国の ISO 3166-2 コード ブラジルの BR などが 反映されています |
なし | ○ |
currency |
「ベース」の ISO 4217 コードまたは 組織で使用している会計通貨(米国の場合は USD など) 。 収益分配プランの場合: 指定した通貨がプランに使用されます。 レート表(課金モデル)プランの場合: 収益分配プランの場合と同じです。 ただし、通貨の設定を Google Maps Platform でサポートされている任意の通貨に できます。 料金のみのプランの場合: 通貨の設定は、サポートされている任意の通貨に変更できます。 組織に提供します。 |
なし | ○ |
description |
組織の簡単な説明。 |
なし | いいえ |
hasBillingAdjustment |
調整が有効かどうかを指定するフラグ。有効にすると、 API プロダクトに関して API サービスによって記録されたトラフィックの詳細に対する調整 value は次のいずれかです。
|
なし | いいえ |
hasBroker |
収益が純額に基づいているかどうかを指定するフラグ。値は次のいずれかです。 次のとおりです。
|
なし | いいえ |
hasSelfBilling |
収益ではなく自己請求を生成するように収益化を指示するフラグ 共有ステートメントがあります。自己請求請求書は、金額の詳細が記載された財務文書です。 アプリのデベロッパーによるものですお客様に代わって API プロバイダに対する請求書として機能し、 アプリ デベロッパーです。次のいずれかの値を指定できます。
|
なし | いいえ |
hasSeparateInvoiceForProduct |
API プロダクトごとに個別の請求書を生成するかどうかを指定するフラグ。「 value は次のいずれかです。
|
なし | いいえ |
id |
組織の ID。 |
なし | いいえ |
issueNettingStmt |
請求の作成時に相殺明細書が生成されるかどうかを指定するフラグ ドキュメントをご覧ください次のいずれかの値を指定できます。
|
なし | いいえ |
logoUrl |
組織のロゴの URL。 |
なし | いいえ |
name |
組織の名前。 |
なし | ○ |
netPaymentAdviceNote |
ネット決済に関するアドバイスのメモ。 |
なし | いいえ |
nettingStmtPerCurrency |
取引ごとに個別の相殺明細書が生成されるかどうかを指定するフラグ 使用通貨。次のいずれかの値を指定できます。
|
なし | いいえ |
regNo |
組織の登録番号。このプロパティに入力する数値は、 請求書の下部に表示されます |
なし | いいえ |
selfBillingAsExchOrg |
自己請求請求書が有効になっている場合は、交換が有効になっているかどうかを示します。 組織に提供します。次のいずれかの値を指定できます。
|
なし | いいえ |
selfBillingForAllDev |
自己請求請求書が有効になっている場合は、すべての請求書に対して有効かどうかを示します。 アプリデベロッパーデフォルトでは、自己請求の請求書は、 API プロバイダと契約を結んでいる必要があります。次のいずれかの値を指定できます。
|
false | いいえ |
separateInvoiceForFees |
料金の請求書を別途発行するかどうかを指定するフラグ。値は次のいずれかです。 次のいずれかになります。
|
false | ○ |
status |
組織のステータス。有効な値は次のとおりです。
|
なし | いいえ |
supportedBillingType |
請求に使用されるデベロッパーの支払いモデル。値は次のいずれかになります。
API を使用した前払い請求タイプと後払い請求タイプの構成をご覧ください。 |
前払い | ○ |
taxModel |
注: 収益分配の料金プランを設定し、 請求書を生成できます 必要な請求書類の種類を識別する、収益分配料金プランの税モデル。 有効な値は次のとおりです。
|
なし | ○ |
taxNexus |
税務上の目的で組織が登録されている国。 |
なし | いいえ |
taxRegNo |
組織の税務登録番号または付加価値税(VAT)の登録番号 。この宿泊施設は、税務登録番号または VAT 登録番号は一部の国では適用されません。ここで入力する数値は、 パラメータが請求ドキュメントの下部に表示されます。 |
なし | いいえ |
transactionRelayURL |
トランザクションをリレーできる別のシステムの URL(データなど) ウェアハウスです |
なし | いいえ |
timezone |
組織業務におけるタイムゾーン ID America/New_York や Europe/Paris などです。タイムゾーンの略語(UTC、EST(東部標準時)など) 標準時間、CET(中央ヨーロッパ時間)もサポートされています。 |
なし | ○ |
会社またはアプリ デベロッパーの収益化プロファイル設定のオーバーライド
以下のセクションで説明するように、UI または API を使用して、会社またはアプリ デベロッパーの収益化プロファイルの設定をオーバーライドします。