<ph type="x-smartling-placeholder"></ph>
現在、Apigee Edge のドキュメントが表示されています。
Apigee X のドキュメント。 詳細
Monetization が提供する一連の API を使用すると、以前に 停止されている場合があります。次のような場合は、デベロッパーが停止されることがあります。 できます。たとえば、トランザクションの数が上限に達した場合、 利用限度額があるか、前払い残高がなくなったとします。理由コードの一覧については、以下をご覧ください。 デベロッパーが停止された場合の理由コードの概要
API を使用して、停止中のすべてのデベロッパーを表示する
以下に対して GET リクエストを発行して、組織で停止中のデベロッパーをすべて表示します。
リソース: /organizations/{org_name}/suspended-developers
。
ここで
{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 リクエストを発行して、組織で停止中のデベロッパーを表示します。
resource:
/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 プロダクトのすべてのデベロッパーの停止を解除する
POST リクエストを発行して、API プロダクトに対して停止されたすべてのデベロッパーの停止を解除する
次のリソースに送信します。
/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
。
ここで
{org_name}
には組織の名前を指定します。{suspendedProduct_id}
には、API プロダクトの ID を次の形式で指定します。{org_id}@@@{product_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 を使用してデベロッパーの停止を解除する
一時停止された特定のデベロッパーの一時停止を解除するには、DELETE リクエストを リソース /organizations/{org_name}/suspended-developers/{suspendedDev_id} です。
ここで
{org_name}
には組織の名前を指定します。{suspendedDev_id}
には、停止中のデベロッパーの ID を次の形式で指定します。{org_id}@@@{dev_id}
のようになります。この値は すべてまたは特定の停止中のデベロッパーを表示する場合はdevId
に設定します。API を使用して停止中のデベロッパーを表示すると API を使用して停止中のデベロッパーを表示するをご覧ください。
必要に応じて、次のクエリ パラメータを渡すことができます。
クエリ パラメータ | 説明 |
---|---|
suspendedProduct_id |
API プロダクトの ID。次のような形式を使用します。
{org_id}@@@{product_id} 。次の場合、この値は prodId として返されます。
すべてまたは特定の停止中のデベロッパーを表示するには、API を使用して停止中のデベロッパーを表示すると API を使用して停止中のデベロッパーを表示するをご覧ください。 |
たとえば、次の cURL 呼び出しでは、ID を持つデベロッパーの停止が解除されます。
API プロダクト myorg@@@myproduct
の 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 |
設定された最終的な音量帯域の上限に達しました。 |