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

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

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

組織のプロフィールについて

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

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

組織に関する基本情報を構成します。

  • 組織名、住所、事業を行っている国
  • 請求タイプの概要で説明されている請求タイプ(前払い、後払い、または両方)
  • 請求期間(日割り計算またはカレンダー月)
  • 基本通貨
  • 組織で使用されている税モデル

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

[組織のプロファイル] ページについて

下記の手順に沿って [Organization Profile] ページにアクセスします。

エッジ

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

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

[Organization Profile] ページが表示されます。

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

  • 現在の組織プロファイルの設定を表示する
  • 組織プロファイルの設定を編集します。編集できる設定は次のとおりです。

Classic Edge(Private Cloud)

Classic Edge UI を使用して [Organization Profile] ページにアクセスするには:

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

[Organization Profile] ページが表示されます。

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

  • 現在の組織プロファイルの設定を表示する
  • 組織プロファイルの設定を編集します。編集できる設定は次のとおりです。

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

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

  1. 組織のプロフィール ページにアクセスします。
  2. [編集] をクリックします。
  3. [名前と情報] で、組織名と運営国を編集します。
  4. [税金と通貨] で、次のフィールドを編集します。
    フィールド 説明
    税金モデル

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

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

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

    • 開示: API プロバイダがデベロッパーの開示代理人として行動します。エンドユーザーから徴収した総収益(売上税を含む)はデベロッパーに渡されます。API プロバイダのコミッションは、コミッション請求書の形式でデベロッパーから徴収されます。API プロバイダはエンドユーザーから徴収した売上税を処理しません。売上税の報告はデベロッパーの責任となります。
    • 非開示: API プロバイダはデベロッパーの非開示代理人として、エンドユーザーから徴収した税金を控除し、地方税務当局に支払います。デベロッパーは、デベロッパーに支払われる純収益の分配額(売上税と API プロバイダの手数料を差し引いた額)を API プロバイダに請求します。
    • ハイブリッド: API プロバイダがデベロッパーの開示代理人として行動します。ただし、API プロバイダは、契約者から集めた売上税をデベロッパーに代わって地方税務当局に支払います。API プロバイダは、残りの収益をデベロッパーに渡し、コミッション料金の請求書を発行します。
    通貨

    組織がサポートしている通貨。収益分配、料金表、手数料のみのプランでは、料金プランにデフォルトの通貨が使用されます。レートカードまたは手数料のみのプランを作成する際に、サポートされている通貨のリストから選択して、使用する通貨を変更できます。必要に応じて、アプリ デベロッパーが前払いアカウントの残高に追加できる最小チャージ額を通貨ごとに設定できます。

    通貨を追加するには:

    1. [通貨を追加] をクリックします。
    2. [Currency] フィールドのプルダウン メニューから通貨を選択します。
    3. 必要に応じて、アプリ デベロッパーが指定した通貨で前払いアカウントの残高に追加できる最小額を [最小チャージ額] フィールドに設定します。
    4. [追加] をクリックします。
    5. 関連するラジオボタンをクリックして、必要に応じてデフォルトの通貨として設定します。
    6. 手順を繰り返して、通貨を追加します。

    通貨を削除するには、削除する通貨にカーソルを合わせて をクリックします。

  5. UI を使用して利用規約を管理するで説明されているように、利用規約を管理します。
  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 プロパティを PREPAIDPOSTPAIDBOTH のいずれかの値に設定して、有効な請求タイプを指定します。値を 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

請求期間。値は次のいずれかになります。

  • PRORATED: API を使用した当月の日数に基づいて請求が行われます。
  • CALENDAR_MONTH: 月単位で請求が行われます。

API を使用して請求期間を構成するをご覧ください。

なし
country

組織の事業国の ISO 3166-2 コード(ブラジルの場合は BR など)。

なし
currency

組織が使用する「基準」通貨または会計通貨の ISO 4217 コード(米国ドルならば USD など)。

収益分配プランの場合: 指定された通貨がプランで使用されます。

レートカード(課金モデル)プランの場合: 収益分配プランの場合と同じです。ただし、通貨設定は組織でサポートされている任意の通貨に変更できます。

料金のみのプランの場合: 通貨設定は、組織でサポートされている任意の通貨に変更できます。

なし
description

組織の簡単な説明。

なし いいえ
hasBillingAdjustment

調整が有効かどうかを指定するフラグ。有効にすると、API プロダクトの API Services によって記録されたトラフィックの詳細を調整できます。値は次のいずれかになります。

  • true: 調整が有効になっています。
  • false: 調整は有効になっていません。
なし いいえ
hasBroker

収益が純益に基づいているかどうかを指定するフラグ。値は次のいずれかになります。

  • true: 収益は純益に基づいています。
  • false: 収益は純益に基づきません。
なし いいえ
hasSelfBilling

収益分配明細の代わりに自己請求書を生成するよう収益化に指示するフラグ。自己請求書は、アプリ デベロッパーの請求額の詳細を示す財務書類です。アプリ デベロッパーの代理である API プロバイダへの請求書としての役割を果たします。値は次のいずれかになります。

  • true: 収益分配明細の代わりに自己請求書を生成します。
  • false: 自己請求書を無効にします。
なし いいえ
hasSeparateInvoiceForProduct

API プロダクトごとに個別の請求書が生成されるかどうかを指定するフラグ。値は次のいずれかになります。

  • true: API プロダクトごとに個別の請求書が生成されます。
  • false: API プロダクトごとに別々の請求書は生成されません。
なし いいえ
id

組織の ID。

なし いいえ
issueNettingStmt

請求書を作成するときに相殺明細書を生成するかどうかを指定するフラグ。値は次のいずれかになります。

  • true: 請求書の作成時にネッティング明細書が生成されます。
  • false: 請求書の作成時にネッティング明細書は生成されません。
なし いいえ
logoUrl

組織のロゴの URL。

なし いいえ
name

組織の名前。

なし
netPaymentAdviceNote

純支払いの通知メモ。

なし いいえ
nettingStmtPerCurrency

使用された通貨ごとに個別の相殺明細書を生成するかどうかを指定するフラグ。値は次のいずれかになります。

  • true: 使用された通貨ごとに個別の相殺明細書が生成されます。
  • false: 使用された通貨ごとに個別の相殺明細書は生成されません。
なし いいえ
regNo

組織の登録番号。このプロパティに入力した番号は、請求書の下部に表示されます。

なし いいえ
selfBillingAsExchOrg

自己請求書が有効になっている場合、交換組織で有効になっているかどうかを示します。値は次のいずれかになります。

  • true: エクスチェンジ組織で自己請求書が有効になっています。
  • false: 交換組織ではセルフビリング請求書は有効になっていません。
なし いいえ
selfBillingForAllDev

自己請求書が有効になっている場合、すべてのアプリ デベロッパーに対して有効になっているかどうかを示します。デフォルトでは、自己請求書は API プロバイダと契約を締結したアプリ デベロッパーに対してのみ生成されます。値は次のいずれかになります。

  • true: すべてのアプリ デベロッパーでセルフビリング請求書が有効になります。
  • false: すべてのアプリ デベロッパーで自己請求書が有効になっているわけではありません。
false いいえ
separateInvoiceForFees

料金に対して個別の請求書が発行されるかどうかを指定するフラグ。値は次のいずれかになります。

  • true: 料金に対して個別の請求書が発行されます。
  • false: 料金の請求書は別途発行されません。
false
status

組織のステータス。有効な値は次のとおりです。

  • ACTIVE: 組織アカウントが収益化に登録されており、使用可能です。
  • INACTIVE: 組織アカウントは収益化に登録されていますが、使用できません。
なし いいえ
supportedBillingType

請求に使用されるデベロッパー支払いモデル。値は次のいずれかになります。

  • PREPAID: デベロッパーは API プロダクトの使用料を前もって支払います。API プロダクトが使用されたときに、その使用料がデベロッパーの残高から差し引かれます。デベロッパーは、API プロダクトを購入するのに十分なプリペイド残高を維持する必要があります。
  • POSTPAID: API プロダクトの使用料が毎月(請求書を通じて)デベロッパーに請求されます。デベロッパーは、請求書に含まれるプランで設定された支払い条件に基づいて、API プロダクトの使用料を支払います。
  • BOTH: 上記のいずれの課金タイプも使用できます。デフォルトは PREPAID です。

API を使用して前払いと後払いの課金タイプを構成するをご覧ください。

PREPAID
taxModel

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

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

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

  • 開示: API プロバイダがデベロッパーの開示代理人として行動します。エンドユーザーから徴収した総収益(売上税を含む)はデベロッパーに渡されます。API プロバイダのコミッションは、コミッション請求書の形式でデベロッパーから徴収されます。API プロバイダはエンドユーザーから徴収した売上税を処理しません。売上税の報告はデベロッパーの責任となります。
  • 非開示: API プロバイダはデベロッパーの非開示代理人として、エンドユーザーから徴収した税金を控除し、地方税務当局に支払います。デベロッパーは、デベロッパーに支払われる純収益の分配額(売上税と API プロバイダの手数料を差し引いた額)を API プロバイダに請求します。
  • ハイブリッド: API プロバイダがデベロッパーの開示代理人として行動します。ただし、API プロバイダは、契約者から集めた売上税をデベロッパーに代わって地方税務当局に支払います。API プロバイダは、残りの収益をデベロッパーに渡し、コミッション料金の請求書を発行します。
なし
taxNexus

組織が税務上の目的で登録されている国。

なし いいえ
taxRegNo

組織の税務登録番号または付加価値税(VAT)登録番号(該当する場合)。税金登録番号または VAT 登録番号はすべての国に適用されるわけではないため、このプロパティは省略可能です。このパラメータに入力した番号は、請求書の下部に表示されます。

なし いいえ
transactionRelayURL

トランザクションをリレーできる別のシステム(データ ウェアハウスなど)の URL。

なし いいえ
timezone

組織の業務のタイムゾーン ID(America/New_York や Europe/Paris など)。UTC、EST(東部標準時)、CET(中央ヨーロッパ時間)などのタイムゾーンの略称もサポートされています。

なし

企業またはアプリ デベロッパーの収益化プロファイル設定をオーバーライドする

次のセクションで説明するように、UI または API を使用して、会社またはアプリ デベロッパーの収益化プロファイル設定をオーバーライドします。