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

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください
情報

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

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

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

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

次のような、組織の基本情報を設定します。

  • 組織名、住所、事業を運営している国
  • 請求タイプ(前払い、後払い、またはその両方)(請求タイプについてを参照)
  • 請求期間(日割り計算または暦月)
  • 基本通貨
  • 組織で使用している税モデル

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

組織のプロフィール ページを確認する

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

エッジ

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

  1. apigee.com/edge にログインします。
  2. 左側のナビゲーション バーで [Publish] > [Monetization] > [Organization Profile] を選択します。

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

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

  • 現在の組織プロファイルの設定を表示する
  • 次のような組織のプロフィール設定を編集します。

従来の Edge(Private Cloud)

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

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

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

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

  • 現在の組織プロファイルの設定を表示する
  • 次のような組織のプロフィール設定を編集します。

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

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

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

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

    収益分配料金プランの税モデル。必要な請求ドキュメントの種類を指定します。

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

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

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

    通貨を追加するには:

    1. [通貨を追加] をクリックします。
    2. [通貨] フィールドのプルダウン メニューから通貨を選択します。
    3. 必要に応じて、[Minimum top-up] 項目で、指定した通貨でアプリ デベロッパーが前払いのアカウント残高に追加できる最小金額を設定します。
    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 を使用して組織プロファイルを編集する

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 プロパティに有効な請求タイプ(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: 請求は、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

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

  • 比例配分: 1 暦月のうち API プロダクトが使用された日数に基づいて課金されます。
  • CALENDAR_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

組織のロゴの URL。

なし ×
name

組織の名前。

なし
netPaymentAdviceNote

純支払いに関するアドバイスのメモ。

なし ×
nettingStmtPerCurrency

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

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

組織の登録番号。このプロパティに入力した番号は、お支払いドキュメントの下部に表示されます。

なし ×
selfBillingAsExchOrg

自己請求書が有効な場合、エクスチェンジ組織で有効になっているかどうかを示します。次のいずれかの値を指定できます。

  • true: エクスチェンジ組織に対して自己請求の請求書が有効になります。
  • false: エクスチェンジ組織では自己請求書が有効になっていません。
なし ×
selfBillingForAllDev

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

  • true: 自己請求書はすべてのアプリ デベロッパーに対して有効になります。
  • false: 自己請求書は、一部のアプリ デベロッパーに対して有効になっていません。
false ×
separateInvoiceForFees

料金に対して別の請求書が公開されるかどうかを指定するフラグ。次のいずれかの値を指定できます。

  • true: 有料の別の請求書が公開されます。
  • false: 料金の請求書は別途発行されません。
false
status

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

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

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

  • 前払い: デベロッパーは、API プロダクトの使用料を事前に支払います。API プロダクトの使用時に、デベロッパーの残高から金額が差し引かれます。デベロッパーは、API プロダクトを購入するのに十分な前払い残高を保持する必要があります。
  • POSTPAID: API プロダクトの使用料金がデベロッパーに(請求書を通じて)毎月請求されます。デベロッパーは、請求書に含まれるプランで設定された支払い条件に基づいて、API プロダクトの使用量を支払います。
  • 両方: どちらの請求タイプにも対応します。デフォルトは PREPAID です。

API を使用した前払いと後払いの請求タイプの設定をご覧ください。

前払い
taxModel

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

収益分配料金プランの税モデル。必要な請求ドキュメントの種類を指定します。

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

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

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

なし ×
taxRegNo

組織の税務登録番号または付加価値税(VAT)登録番号(該当する場合)。国によっては納税者番号または VAT 登録番号が適用されないため、このプロパティは省略可能です。このパラメータに入力した数値は、請求ドキュメントの下部に表示されます。

なし ×
transactionRelayURL

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

なし ×
timezone

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

なし

会社またはアプリ デベロッパーの収益化プロファイル設定のオーバーライド

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