شما در حال مشاهده مستندات 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
با ارسال یک درخواست POST به منبع زیر، تمام توسعهدهندگانی که به دلیل استفاده از یک محصول API تعلیق شدهاند را از حالت تعلیق خارج کنید: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id} .
کجا:
-
{org_name} نام سازمان را مشخص میکند. -
{suspendedProduct_id}شناسه محصول API را با استفاده از قالبی مشابه زیر مشخص میکند:{org_id}@@@{product_id}. این مقدار هنگام مشاهده همه یا برخی از توسعهدهندگان معلق، همانطور که در «مشاهده همه توسعهدهندگان معلق با استفاده از API» و «مشاهده یک توسعهدهنده معلق با استفاده از API» توضیح داده شده است، به صورتprodIdبرگردانده میشود.
برای مثال، فراخوانی 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}. این مقدار هنگام مشاهدهی همه یا برخی از توسعهدهندگان معلق، همانطور که در «مشاهدهی همه توسعهدهندگان معلق با استفاده از API» و «مشاهدهی یک توسعهدهندهی معلق با استفاده از API» توضیح داده شده است، به صورتdevIdبرگردانده میشود.
به صورت اختیاری، میتوانید پارامتر پرسوجوی زیر را ارسال کنید:
| پارامتر پرس و جو | توضیحات |
|---|---|
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 | به حد مجاز تعیینشده برای آخرین باند صدا رسیده است. |
شما در حال مشاهده مستندات 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
با ارسال یک درخواست POST به منبع زیر، تمام توسعهدهندگانی که به دلیل استفاده از یک محصول API تعلیق شدهاند را از حالت تعلیق خارج کنید: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id} .
کجا:
-
{org_name} نام سازمان را مشخص میکند. -
{suspendedProduct_id}شناسه محصول API را با استفاده از قالبی مشابه زیر مشخص میکند:{org_id}@@@{product_id}. این مقدار هنگام مشاهده همه یا برخی از توسعهدهندگان معلق، همانطور که در «مشاهده همه توسعهدهندگان معلق با استفاده از API» و «مشاهده یک توسعهدهنده معلق با استفاده از API» توضیح داده شده است، به صورتprodIdبرگردانده میشود.
برای مثال، فراخوانی 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}. این مقدار هنگام مشاهدهی همه یا برخی از توسعهدهندگان معلق، همانطور که در «مشاهدهی همه توسعهدهندگان معلق با استفاده از API» و «مشاهدهی یک توسعهدهندهی معلق با استفاده از API» توضیح داده شده است، به صورتdevIdبرگردانده میشود.
به صورت اختیاری، میتوانید پارامتر پرسوجوی زیر را ارسال کنید:
| پارامتر پرس و جو | توضیحات |
|---|---|
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 | به حد مجاز تعیینشده برای آخرین باند صدا رسیده است. |