רכישה וניהול של מינויים למוצרי API באמצעות ה-API

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

אם אתם רוצים לבנות פורטל מותאם אישית משלכם או לנהל את תהליך הרכישה באופן ידני, בקטעים הבאים מוסבר איך לרכוש ולנהל מינויים למוצרי API באמצעות ה-API. בדוגמאות האלה מוסבר איך לנהל מינויים למפתחי אפליקציות ולקבוצות אפליקציות.

אפשר לעיין גם במאמר בנושא שילוב מונטיזציה של Apigee בפורטל מפתחים מבוסס Drupal.

ניהול מינויים של מפתחי אפליקציות

מפתחי אפליקציות: רכישת מינויים למוצרי API באמצעות ה-API

כדי לרכוש מינוי למוצר API, שולחים בקשת POST ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

כדי להגדיר את בקשת המינוי למוצר ה-API, מעבירים את שדות החובה בגוף הבקשה, כפי שמתואר במאמר Resource: Subscriptions.

לדוגמה, הקריאה הבאה ל-API רוכשת מינוי למוצר HelloworldProduct API עבור המפתח שצוין: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

בהמשך מופיעה דוגמה לפלט של התגובה. השעה שמוגדרת היא השעה הנוכחית.startTime

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

מידע נוסף זמין במאמר בנושא Purchase API product subscription API

מפתח אפליקציות: ביטול מינוי למוצר API באופן מיידי

כדי להגדיר שמינוי למוצר API יפוג באופן מיידי, שולחים בקשת POST ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

לדוגמה, קריאה ל-API הבאה מבטלת את המינוי למוצר ה-API בשם 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 עבור המפתח שצוין: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

בהמשך מופיעה דוגמה לפלט של התגובה. השעה שמוגדרת היא השעה הנוכחית.endTime

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

מפתח אפליקציות: הצגת רשימה של כל המינויים למוצרי API של מפתח

כדי להציג רשימה של כל המינויים למוצרי API של מפתח, שולחים בקשת GET אל ה-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

אפשר גם להעביר את השדות הבאים כדי לתמוך בעימוד:

  • ‫startKey כדי לציין את השם של המינוי למוצר ה-API שממנו רוצים להתחיל להציג את רשימת המינויים. אם לא מציינים ערך, הרשימה מתחילה מהפריט הראשון. אפשר להשתמש ב-count כדי לספק סינון ממוקד יותר. לדוגמה, כדי להציג את המינויים למוצר API מ-51 עד 150, מגדירים את הערך של startKey לשם של המינוי ה-51 ואת הערך של count ל-100.
  • ‫count כדי לציין את מספר התוכניות התמחוריות שיוחזרו בקריאה ל-API. אפשר להשתמש ב- startKey כדי לספק סינון ממוקד יותר. המגבלה המקסימלית היא 1,000. ברירת המחדל היא 100.

לדוגמה, הקריאה הבאה ל-API מציגה רשימה של כל המינויים למוצרי API עבור המפתח שצוין: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט התגובה:

{
  "developerSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

מידע נוסף זמין במאמר List API product subscriptions API.

מפתח אפליקציות: הצגת פרטים של מינוי למוצר API

כדי לראות פרטים על מינוי למוצר API של מפתח, שולחים בקשת GET ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

לדוגמה, הקריאה הבאה ל-API מאחזרת פרטים על מינוי למוצר API עבור המפתח שצוין: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט התגובה:

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

מידע נוסף מופיע במאמר Get API product subscription API.

ניהול מינויים של AppGroup

בקטע הזה מופיעות דוגמאות לניהול מינויים למוצרי API עבור AppGroups. מידע נוסף על ממשקי ה-API שמשמשים לניהול מינויים של קבוצות אפליקציות זמין במאמר משאב: מינויים.

AppGroup: Purchase API product subscriptions using the API

במאמר שימוש ב-AppGroups לניהול מינויים למוצרי API מוסבר מהן הדרישות לשימוש ב-AppGroups עם מינויים למוצרי API.

כדי לרכוש מינוי למוצר API, שולחים בקשת POST ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions.

כדי להגדיר את בקשת המינוי למוצר ה-API, מעבירים את שדות החובה בגוף הבקשה, כפי שמתואר במאמר Resource: Subscriptions.

לדוגמה, הקריאה הבאה ל-API רוכשת מינוי למוצר HelloworldProduct API עבור קבוצת האפליקציות שצוינה: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

בהמשך מופיעה דוגמה לפלט של התגובה. השעה שמוגדרת היא השעה הנוכחית.startTime

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

מידע נוסף זמין במאמר בנושא Purchase API product subscription API

AppGroup: Expire an API product subscription immediately

כדי להגדיר שמינוי למוצר API יפוג באופן מיידי, שולחים בקשת POST ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION:expire

לדוגמה, קריאה ל-API הבאה מבטלת את המינוי למוצר ה-API בשם 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 עבור קבוצת האפליקציות שצוינה: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

בהמשך מופיעה דוגמה לפלט של התגובה. השעה שמוגדרת היא השעה הנוכחית.endTime

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

AppGroup: List all API product subscriptions

כדי להציג רשימה של כל המינויים למוצרי API של קבוצת אפליקציות, שולחים בקשת GET אל ה-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions

אפשר גם להעביר את השדות הבאים כדי לתמוך בעימוד:

  • ‫startKey כדי לציין את השם של המינוי למוצר ה-API שממנו רוצים להתחיל להציג את רשימת המינויים. אם לא מציינים ערך, הרשימה מתחילה מהפריט הראשון. אפשר להשתמש ב-count כדי לספק סינון ממוקד יותר. לדוגמה, כדי להציג את המינויים למוצר API מ-51 עד 150, מגדירים את הערך של startKey לשם של המינוי ה-51 ואת הערך של count ל-100.
  • ‫count כדי לציין את מספר התוכניות התמחוריות שיוחזרו בקריאה ל-API. אפשר להשתמש ב- startKey כדי לספק סינון ממוקד יותר. המגבלה המקסימלית היא 1,000. ברירת המחדל היא 100.

לדוגמה, הקריאה הבאה ל-API מציגה רשימה של כל המינויים למוצרי API עבור קבוצת האפליקציות שצוינה: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט התגובה:

{
  "appGroupSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

מידע נוסף זמין במאמר List API product subscriptions API.

AppGroup: הצגת פרטים על מינוי למוצר API

כדי לראות פרטים על מינוי למוצר API של קבוצת אפליקציות, שולחים בקשת GET ל-API הבא: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION

לדוגמה, הקריאה הבאה ל-API מציגה רשימה של מידע על מינוי למוצר API עבור AppGroup שצוין: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

‫$TOKEN מוגדר לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות curl שבהן נעשה שימוש בדוגמה הזו מופיע במאמר שימוש ב-curl. תיאור של משתני הסביבה שבהם אפשר להשתמש מופיע במאמר בנושא הגדרת משתני סביבה לבקשות API של Apigee.

זוהי דוגמה לפלט התגובה:

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

מידע נוסף מופיע במאמר Get API product subscription API.