利用限度額を使用して後払い残高を管理する

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

はじめに

組織でサポートされている通貨を追加する際に、サポートされている通貨の追加で説明されているように、後払い式デベロッパーの利用限度額を設定できます。利用限度額は、組織内のすべての後払いデベロッパーに適用されます。また、以降のセクションで説明するように、個々の後払いデベロッパーの利用限度額を設定することもできます。この場合、指定したデベロッパーのみに対して設定された通貨の上限が利用限度額よりも優先されます。

API を使用した利用限度額の設定

個々のデベロッパーの利用限度額を設定するには、/organizations/{org_name}/developers/{developer_id}/developer-credit-limit に POST リクエストを発行します。ここで、{developer_id} はデベロッパーのメールアドレスです。リクエストを発行する際に、クレジットの金額と使用する通貨をクエリ パラメータとして指定する必要があります。たとえば、次のリクエストでは、開発者の利用限度額を 1, 000 ドルに設定しています。

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev7@myorg/developer-credit-limit?amount=1000&supportedCurrencyId=usd" \
-u email:password

API を使用した利用限度額の取得

後払いデベロッパーの利用限度額を取得するには、/organizations/{org_name}/developers/{developer_id}/developer-credit-limit に GET リクエストを発行します。ここで、{developer_id} はデベロッパーのメールアドレスです。例:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev7@myorg/developer-credit-limit" \
-u email:password

レスポンスは次のようになります(レスポンスの一部のみが表示されます)。

{
  "developerBalance" : [ {
    "amount" : 1000.0000,
    "id" : "ddd98cd5-06bc-481b-ae42-76a7345933a9",
    "supportedCurrency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "usage" : 76.6052
  } ],
  "totalRecords" : 1
}

次のステップ

収益化を使用して払い戻し(購入取引のみ)を送信できます。方法については、払い戻しを行う場合をご覧ください。