デベロッパーの収益化への移行

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

収益化に移行する必要がある既存のデベロッパーがいる場合:

  1. 移行するデベロッパーの API プロダクト、API パッケージ、料金プランがまだ存在しない場合は、作成します。詳細については、次をご覧ください。
  2. 料金プランを公開するの説明に沿って、料金プランを公開します。
  3. アプリ デベロッパーを登録するの説明に従って、新しいデベロッパーを組織に追加します。
  4. 前払いアカウントの残高を管理するの説明に従って、デベロッパーごとにプリペイド残高をチャージします。
  5. API を使用して料金プランを購入するで説明されているように、料金プランを承認します。

    注: 設定手数料を免除するには、デベロッパーにすでに請求されている場合は、waivefees クエリ パラメータを true に設定します。

  6. 移行するデベロッパーに既存のトランザクションがある場合は、次のリソース
    /organizations/{org_name}/transactions を使用して、トランザクションの使用状況を手動で転送できます。ここで、{org_name} は組織の名前です。

    注: 既存のトランザクションがない場合は、この手順をスキップできます。

    transactions リソースは、現在のトランザクション使用量を反映する単一のトランザクションを挿入し、この新しい値を反映するようにすべての内部カウンタを更新します。

    たとえば、移行前にデベロッパーが API を 1,000 回呼び出している場合、現在のアクティビティをキャプチャするには、transactions リソースを呼び出し、リクエスト本文で batchSize プロパティを 1,000 に設定して、トランザクション使用量を 1,000 に設定します。

    次の表に、リクエスト本文で指定して、トランザクションの数、デフォルト値、必須かどうかを手動で設定できる構成プロパティを示します。

    プロパティ 説明 デフォルト 必須かどうか
    application

    デベロッパー アプリの ID。

    		 なし ○
    batchSize

    移行するトランザクションの数。

    		 1 いいえ
    custAttn

    batchSize でトランザクションの使用量を計算するために使用されるカスタム属性の値。

    メッセージ内のカスタム属性の数値は、正の整数または小数（小数点以下 4 桁まで）の値として指定する必要があります。負の値は使用できません。

    カスタム属性は次の場所で定義する必要があります。

    		 なし ○
    product

    API プロダクトの ID。

    		 なし ○
    type

    CHARGE（デフォルト）に設定する必要があります。

    		 CHARGE いいえ

    検証ステップをスキップしてトランザクション数を強制的に設定するには、force クエリ パラメータを true に設定します（例: ?force=true）。デフォルトでは、?force=false と検証ステップが実行されます。たとえば、前払いデベロッパーのアカウントの残高がゼロで、アカウントのアクティビティが停止されている場合、?force=false リクエストは検証中に失敗します。

    たとえば、次のリクエストは、指定されたアプリケーションと API プロダクトのトランザクション数を 50 に設定します。

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize":50
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password

    次のリクエストでは、指定されたアプリケーションと API プロダクトのトランザクション使用量を 12.5 に設定します。リクエストでは、batchSize が 125 に設定され、API プロダクトに定義された最初のカスタム属性の値が 0.1 に設定されます。125 * 0.1 = 12.5 となります。

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize": 125,
   "custAtt1" : 0.1
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password
  7. デベロッパーに設定料金または定期的な料金が課金されていない場合は、次のリソース
    /organizations/{org_name}/transactions を使用して、料金プランの設定料金または定期的な料金を手動で課金できます。ここで、{org_name} は組織の名前です。

    注: デベロッパーにすでに設定料金または定期料金が請求されている場合は、この手順をスキップできます。transactions リソースを呼び出しても、料金プランで定義された設定料金や定期的な料金には影響しません。

    次の表に、料金プランの設定料金または定期料金を手動で請求するためにリクエスト本文で指定できる構成プロパティ、そのデフォルト値、必須かどうかを示します。

    プロパティ 説明 デフォルト 必須かどうか
    currency

    料金プランで使用される通貨。通貨の ISO 4217 コードを指定します（例: 米ドルの場合は usd、スイス フランの場合は chf）。

    		 なし ○
    developer

    デベロッパーの ID。

    		 なし ○
    rate

    請求する設定料金または定期的な料金。

    		 なし ○
    ratePlan

    料金プランの ID。

    		 なし ○
    type

    SETUPFEES または RECURRINGFEES に設定します。

    		 CHARGE ○

    検証手順をスキップして強制的に料金を請求するには、force クエリ パラメータを true に設定します（例: ?force=true）。デフォルトでは、?force=false と検証手順が実行されます。たとえば、前払いデベロッパーのアカウントの残高がゼロで、アカウントのアクティビティが停止されている場合、?force=false リクエストは検証中に失敗します。

    たとえば、次のリクエストでは、料金プランに登録しているデベロッパーに 10 米ドルの設定料金を請求します。

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev1@myorg.com"
   },
   "currency":{
     "id":"usd"
   },
   "ratePlan":{
     "id":"mypackage_rateplan1"
   },   
   "rate":10,
   "type":"SETUPFEES"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password