デベロッパーの停止を解除する

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報

収益化には、以前に停止されたデベロッパーの停止を解除するために使用できる一連の API が用意されています。詳細は、以降のセクションで説明します。設定された上限に達すると、デベロッパーが一時停止される場合があります。たとえば、トランザクション数が上限に達したり、前払い残高がなくなったりした場合などです。理由コードの一覧については、停止されたデベロッパーの理由コードの概要をご覧ください。

API を使用した停止中のすべてのデベロッパーの表示

組織で停止中のデベロッパーをすべて表示するには、リソース /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 を使用して停止中のデベロッパーを表示する

組織で停止中のデベロッパーを表示するには、リソース /organizations/{org_name}/suspended-developers/{developer_email_or_id} に GET リクエストを発行します。

ここで

  • {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 プロダクトのすべてのデベロッパーの停止を解除する

リソース /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id} に POST リクエストを発行して、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 リクエストを発行します。

ここで

必要に応じて、次のクエリ パラメータを渡すことができます。

クエリ パラメータ 説明
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 最終ボリュームバンドの構成済み上限に達しました。