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

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