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

מוצג המסמך של 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 אל resource: /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.

אפשר גם להעביר את הפרמטר הבא של השאילתה:

לדוגמה, קריאת ה-cURL הבאה מבטלת את ההשעיה של המפתח עם המזהה myorg@@@6Vro7VnjUhpGVn3p למוצר myorg@@@myproduct של ה-API:

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

סיכום של קודי הסיבות למפתחים שהושעו

בטבלה הבאה מופיע סיכום של קודי הסיבות שמציינים למה מפתח מושעה.