ביטול ההשעיה של המפתחים

כרגע מוצג התיעוד של 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}.

כאשר:

לדוגמה, הקריאה הבאה ל-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}.

כאשר:

אופציונלי: אפשר להעביר את פרמטר השאילתה הבא:

פרמטר שאילתה התיאור
suspendedProduct_id המזהה של מוצר ה-API בפורמט שדומה לזה: {org_id}@@@{product_id}. הערך הזה מוחזר כ-prodId כשמציגים את כל המפתחים המושעים או ספציפיים, כפי שמתואר בצפייה בכל המפתחים המושעים שמשתמשים ב-API ובצפייה במפתח מושעה באמצעות ה-API.

לדוגמה, הקריאה הבאה ל-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 הגעת למגבלה שהוגדרה בתחום עוצמת הקול הסופית.