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

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

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

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

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

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