Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
Monetization には、以下のセクションで説明するように、以前に停止されたデベロッパーの停止を解除するために使用できる API のセットが用意されています。構成された上限に達すると、デベロッパーが停止される可能性があります。たとえば、取引数が上限に達した、アカウントの前払い残高が不足しているなど。理由コードの一覧については、停止中のデベロッパーの理由コードの概要をご覧ください。
API を使用してすべての停止中のデベロッパーを表示する
1 つの組織で停止されたすべてのデベロッパーを表示するには、/organizations/{org_name}/suspended-developers
に GET リクエストを発行します。
ここで
{org_name}
には、組織の名前を指定します。
たとえば、次の cURL 呼び出しは、myorg
に対して停止されているすべてのデベロッパーを一覧表示します。
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
レスポンスの例を次に示します。
[ { "creationDate": 1464388723633, "devId": "myorg@@@6Vro7VnjUhpGVn3p", "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED", "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED" }, { "creationDate": 1464022846293, "devId": "myorg@@@vXh7LXxtUy9COVdy", "id": "myorg-myorg@@@vXh7LXxtUy9COVdy-myorg@@@myproduct-null-NO_CURRENT_PUBLISHABLE_ENTITY", "message": "mint.productHasBeenSuspended for myorg@@@vXh7LXxtUy9COVdy myorg@@@myproduct due to mint.noCurrentPublishableEntity", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "NO_CURRENT_PUBLISHABLE_ENTITY" } ]をご覧ください。
停止中のデベロッパーを API で表示する
組織の停止中のデベロッパーを表示するには、GET リクエストを次のリソースに送信します: /organizations/{org_name}/suspended-developers/{developer_email_or_id}
。
ここで
{org_name}
には、組織の名前を指定します。{developer_email_or_id}
には、デベロッパーの ID を指定します。デベロッパーの一覧を表示するには、デベロッパーの一覧表示をご覧ください。
たとえば、次の cURL 呼び出しには、停止中のデベロッパー joe@example.com
の詳細が一覧表示されます。
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/joe@example.com" \ -u email:password
レスポンスの例を次に示します。
[ { "creationDate": 1464388723633, "devId": "myorg@@@6Vro7VnjUhpGVn3p", "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED", "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED" } ]をご覧ください。
API を使用して API プロダクトのすべてのデベロッパーの停止を解除する
API プロダクトで停止されているすべてのデベロッパーの停止を解除するには、リソース /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
に POST リクエストを発行します。
ここで
{org_name}
には、組織の名前を指定します。{suspendedProduct_id}
は、{org_id}@@@{product_id}
のような形式を使用して API プロダクトの ID を指定します。この値は、すべてまたは特定の停止中のデベロッパーを表示するとprodId
として返されます。API を使用してすべての停止中のデベロッパーを表示すると API を使用して停止中のデベロッパーを表示するをご覧ください。
たとえば、次の cURL 呼び出しは、API プロダクト myorg@@@myproduct
のすべてのデベロッパーの停止を解除します。
curl -H "Content-Type: application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/unsuspend-by-product/myorg@@@myproduct" \ -u email:password
API を使用してデベロッパーの停止を解除する
一時停止している特定のデベロッパーを、リソース /organizations/{org_name}/suspended-developers/{suspendedDev_id} に DELETE リクエストを発行して、停止を解除します。
ここで
{org_name}
には、組織の名前を指定します。{suspendedDev_id}
には、停止中のデベロッパーの ID を{org_id}@@@{dev_id}
のような形式で指定します。この値は、すべてまたは特定の停止中のデベロッパーを表示するとdevId
として返されます。API を使用してすべての停止中のデベロッパーを表示すると API を使用して停止中のデベロッパーを表示するをご覧ください。
必要に応じて、次のクエリ パラメータを渡すことができます。
クエリ パラメータ | 説明 |
---|---|
suspendedProduct_id |
API プロダクトの ID。形式は {org_id}@@@{product_id} です。この値は、すべてまたは特定の停止中のデベロッパーを表示すると prodId として返されます。API を使用してすべての停止中のデベロッパーを表示すると API を使用して停止中のデベロッパーを表示するをご覧ください。 |
たとえば、次の cURL 呼び出しは、API プロダクト myorg@@@myproduct
の ID が myorg@@@6Vro7VnjUhpGVn3p
のデベロッパーの停止を解除します。
curl -H "Content-Type: application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/myorg@@@6Vro7VnjUhpGVn3p?productId=myorg@@@myproduct" \ -u email:password
デベロッパーが停止された場合の理由コードの概要
次の表に、デベロッパーが停止された理由を示す理由コードをまとめます。
理由コード | 説明 |
---|---|
INSUFFICIENT_FUNDS |
デベロッパー アカウントが不足しています。 |
LIMIT_VIOLATED |
デベロッパー アカウントに構成された上限に達しました。 |
NO_CURRENT_PUBLISHABLE_ENTITY |
デベロッパーが料金プランを承諾(登録)していない。 |
RATE_PLAN_RATE_BAND_EXCEEDED |
最終的な音量帯域の構成済み上限に達しました。 |