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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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