شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات
کسب درآمد مجموعه ای از 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 به منبع زیر، یک برنامهنویس تعلیقشده برای یک سازمان را مشاهده کنید: /organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
کجا:
-
{org_name}
نام سازمان را مشخص میکند. -
{developer_email_or_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 تعلیق شده اند، با ارسال یک درخواست POST به منبع زیر: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
کجا:
-
{org_name}
نام سازمان را مشخص میکند. -
{suspendedProduct_id}
شناسه محصول API را با استفاده از قالبی شبیه به زیر مشخص میکند:{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}
شناسه توسعهدهنده تعلیقشده را با استفاده از قالبی شبیه به زیر مشخص میکند:{org_id}@@@{dev_id}
. این مقدار بهعنوانdevId
برگردانده میشود، هنگامی که همه یا برنامهنویسهای معلق خاصی را مشاهده میکنید، همانطور که در مشاهده همه توسعهدهندگان معلق با استفاده از API و مشاهده یک توسعهدهنده معلق با استفاده از API توضیح داده شده است.
به صورت اختیاری، می توانید پارامتر کوئری زیر را ارسال کنید:
پارامتر پرس و جو | توضیحات |
---|---|
suspendedProduct_id | شناسه محصول API، با استفاده از قالبی شبیه به زیر: {org_id}@@@{product_id} . این مقدار هنگامی که همه یا برنامهنویسهای معلق خاصی را مشاهده میکنید، همانطور که در مشاهده همه توسعهدهندگان معلق با استفاده از API و مشاهده یک توسعهدهنده معلق با استفاده از API توضیح داده شده است، بهعنوان prodId برگردانده میشود. |
برای مثال، تماس cURL زیر، توسعهدهنده با شناسه myorg@@@6Vro7VnjUhpGVn3p
برای محصول API myorg@@@myproduct
لغو تعلیق میکند:
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 | محدودیت پیکربندی شده باند حجم نهایی رسیده است. |