API を使用して料金プランを購入する

<ph type="x-smartling-placeholder"></ph> 現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細

このセクションでは、公開されている料金プランを購入する方法、購入した料金プランを期限切れにする方法または解約する方法について説明します。 料金プランを選択できます

API を使用して公開料金プランを購入する

料金プランが公開されると、デベロッパーや会社は料金プランを購入（「承諾」）できます。 POST リクエストを /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans, ここで、{org_name} は組織の名前、 {developer_or_company_id} は、デベロッパーまたは会社の ID です。

料金プランの購入時に設定料金が発生しないようにするには、waivefees クエリ パラメータを設定します 宛先: trueこのフラグは、デベロッパーを収益化に移行する場合に有用です。 デベロッパーを Google Cloud に移行 収益化

次の表に、Google Cloud コンソールで指定できる構成プロパティ そのデフォルト値、必須かどうかなどが表示されます。

たとえば、次のリクエストでは location_&_messaging 料金プランを購入します。 次のとおりです。

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

この例では、suppressWarning プロパティが false に設定されています。イン 競合が発生するとエラーがスローされます。たとえば、開発者が 購入した別の料金プランと重複する料金プランを購入しようとすると、エラーがスローされます。この 収益化のためのユーザー インターフェースを提供するアプリケーションで、エラーをインターセプトし、 （必要に応じて）競合する商品をデベロッパーに確認して確認してもらう。条件 suppressWarning が true に設定されている場合、収益化によりすべての購入が停止されます。 競合する商品を含む API パッケージに対してデベロッパーが設定している料金プラン。その後 デベロッパーのために新しい API パッケージを購入する。

次のリクエストでは、調整可能な通知料金プランを購入し、ターゲット数を設定します 4,000 にのぼります。

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

上記の例のいずれかで、次のエラー メッセージが返された場合:

Developer legal name not specified. 

次に、収益化属性 MINT_DEVELOPER_ADDRESS と MINT_DEVELOPER_LEGAL_NAMEしてから、API 呼び出しを繰り返します。

デベロッパーが API を使用して購入した料金プランを期限切れにする

デベロッパーが購入した料金プランを期限切れ（または解約）するには、購入した料金プランを更新します。 リクエスト本文で endDate プロパティを指定し、 POST リクエストを /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id} リソース。

料金プランは、その日の月末まで有効です 表示されます。たとえば、料金プランを 2017 年 12 月 1 日に期限切れにする場合は、次のようにします。 endDate の値を設定する 2017-11-30 に変更します。この例では、 料金プランは、2017 年 11 月 30 日の終わりに期限切れになります。すべてのリクエストが 12 月 1 日以降に 2017 年はブロックされます。

購入時のレスポンスで {developer_rateplan_id} が返されます。 公開済みの料金プランで計算されます

例:

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

または、{developer-rateplan-id} を GET リクエストを発行してデベロッパー料金プランを 宛先: /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans、 ここで、{developer_id} はデベロッパーのメールアドレスです。詳細 詳しくは、 デベロッパーが購入したすべての料金プラン。

次のリクエストでは、終了日が 2017 年 12 月 1 日に更新されます。つまり 料金プランは 2017 年 11 月 30 日の終わりに有効期限が切れます。2017 年 12 月 1 日以降のすべてのリクエストは ブロックされています。

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'