אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
אפשר לאגד מוצר API אחד או יותר למאגר יחיד שניתן למונטיזציה, שנקרא חבילת מוצרי API, כמו שמתואר בקטעים הבאים.
מהי חבילת מוצרים של API?
חבילת מוצרי API היא אוסף של מוצרי API שמוצגים למפתחים כקבוצה, ובדרך כלל משויכים לתוכניות תמחור אחת או יותר לצורך מונטיזציה. אפשר ליצור כמה חבילות של מוצרי API ולכלול בכל אחת מהן מוצר API אחד או יותר. אתם יכולים להוסיף את אותו מוצר או מוצרים של API לחבילות שונות ולקשר אותם לתוכניות תמחור שונות (או לאותה תוכנית תמחור).
מפתחים יכולים לרשום את האפליקציות שלהם לשימוש בחבילת מוצרי API רק אם הם רוכשים אחת מתוכניות התמחור שבתוקף כרגע. חבילת מוצרי API לא תהיה גלויה למפתחים עד שתוסיפו ותפרסמו (כציבורית) תוכנית תמחור לחבילת המוצרים (עם תאריך התחלה שהוא התאריך הנוכחי או תאריך עתידי), כפי שמתואר במאמר ניהול תוכניות תמחור. אחרי שתוסיפו ותפרסמו תוכנית תמחור, מפתחים שיתחברו לפורטל המפתחים יוכלו לבחור את חבילת מוצרי ה-API ולבחור את תוכנית התמחור. לחלופין, אפשר לאשר תוכנית תמחור למפתח באמצעות Management API. מידע נוסף זמין במאמר רכישת תוכניות תמחור שפורסמו באמצעות ה-API.
אחרי שמוסיפים חבילת API למוצר API, יכול להיות שיהיה צורך להגדיר נקודות מחיר למוצר ה-API. צריך לעשות את זה רק אם מתקיימים כל התנאים הבאים:
- מגדירים תוכנית לחלוקת הכנסות למוצר ה-API.
- מפתחים גובים מצדדים שלישיים תשלום על השימוש במשאבים במוצר ה-API.
- יש הגבלה על סכום המינימום או המקסימום שמפתחים יכולים לגבות, ואתם רוצים להודיע למפתחים על ההגבלה.
המחירים המינימליים והמקסימליים מוצגים בפרטים של חבילת מוצרי ה-API.
הסבר על הדף 'חבילות של מוצרים'
נכנסים לדף 'חבילות מוצרים' כמו שמתואר בהמשך.
Edge
כדי לגשת לדף של חבילות מוצרי API באמצעות ממשק המשתמש של Edge, בוחרים באפשרות פרסום > מונטיזציה > חבילות מוצרים בסרגל הניווט הימני.

כפי שמודגש באיור הקודם, בדף 'חבילות מוצרים' אפשר:
- הצגת סיכום מידע על כל חבילות המוצרים, כולל שם החבילה ורשימת מוצרי ה-API שהיא מכילה
- הוספת חבילת מוצרים
- עריכת חבילת מוצרים
- חיפוש ברשימת חבילות המוצרים בכל שדה שמוצג
אפשר לנהל את מוצרי ה-API בחבילת מוצרים או למחוק חבילת מוצרים (אם לא הוגדרו תוכניות תמחור) רק באמצעות ה-API.
Classic Edge (ענן פרטי)
כדי לגשת לדף של חבילות ה-API באמצעות ממשק המשתמש הקלאסי של Edge, בוחרים באפשרות Publish > Packages (פרסום > חבילות) בסרגל הניווט העליון.
בדף 'חבילות API' אתם יכולים:
- הצגת סיכום מידע על כל חבילות ה-API, כולל מוצרי ה-API שהן מכילות ותוכניות התמחור המשויכות
- הוספת חבילת API
- עריכה של חבילת API
- הוספה וניהול של תוכניות תמחור
- החלפת הגדרת הגישה לתוכנית התמחור (ציבורית או פרטית)
- סינון רשימת החבילות
אפשר לנהל את מוצרי ה-API בחבילת API או למחוק חבילת API (אם לא הוגדרו תוכניות תמחור) באמצעות ה-API בלבד.
הוספת חבילת מוצרים
כדי להוסיף חבילת מוצרים של API:
- לוחצים על + חבילת מוצרי API בדף חבילות המוצרים.
- מזינים שם לחבילת מוצרי ה-API.
מזינים את השם של מוצר API בשדה 'הוספת מוצר'.
כשמקלידים את השם של מוצר API, מוצגת רשימה נפתחת של מוצרי API שמכילים את המחרוזת. לוחצים על השם של מוצר API כדי להוסיף אותו לחבילה. חוזרים על הפעולה כדי להוסיף עוד מוצרי API.
- חוזרים על שלב 3 כדי להוסיף עוד שמות של מוצרי API.
- לכל מוצר API שמוסיפים, מגדירים את מדיניות תיעוד העסקאות.
- לוחצים על שמירת חבילת המוצרים.
עריכת חבילת מוצרים
כדי לערוך חבילת מוצרים:
בדף חבילות המוצרים, לוחצים בתוך השורה של חבילת המוצרים שרוצים לערוך.
מוצגת החלונית של חבילת המוצרים.
עורכים את השדות של חבילת המוצרים לפי הצורך.
מידע נוסף זמין במאמר בנושא הגדרת מדיניות הקלטת העסקאות.
- לוחצים על עדכון חבילת מוצרים.
ניהול חבילות של מוצרי API באמצעות ה-API
בקטעים הבאים מוסבר איך לנהל חבילות של מוצרי API באמצעות ה-API.
יצירת חבילת מוצרי API באמצעות API
כדי ליצור חבילת מוצרי API, שולחים בקשת POST אל
/organizations/{org_name}/monetization-packages. כששולחים את הבקשה, צריך:
- מזהים את מוצרי ה-API שרוצים לכלול בחבילת מוצרי ה-API.
- מציינים שם ותיאור לחבילת מוצרי ה-API.
- הגדרת אינדיקטור סטטוס לחבילת מוצרי ה-API. הערך של אינדיקטור הסטטוס יכול להיות אחד מהערכים הבאים: CREATED, ACTIVE, INACTIVE. נכון לעכשיו, ערך מחוון הסטטוס שאתם מציינים נשמר בחבילת המוצרים של ה-API, אבל הוא לא משמש לשום מטרה.
אפשר גם לציין את הארגון.
רשימת האפשרויות שמוצגות ב-API מפורטת במאמר מאפייני הגדרה של חבילות מוצרי API.
לדוגמה:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"description": "payment messaging package",
"displayName": "Payment Messaging Package",
"name": "Payment Messaging Package",
"organization": { "id": "{org_name}" },
"product": [
{ "id": "messaging" },
{ "id": "payment" }
],
"status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password
זוהי דוגמה לתגובה:
{ "description" : "payment messaging package", "displayName" : "Payment Messaging Package", "id" : "payment_messaging_package", "name" : "Payment Messaging Package", "organization" : { "id" : "{org_name}", "separateInvoiceForFees" : false }, "product" : [ { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { "id" : "{org_name}", "separateInvoiceForFees" : false }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { "id" : "{org_name}", "separateInvoiceForFees" : false }, "status" : "CREATED" }], "status" : "CREATED" }
שימו לב שהתשובה כוללת מידע נוסף על מוצרי ה-API ועל מאפיינים מותאמים אישית שצוינו עבור מוצרי ה-API האלה. (מאפיינים בהתאמה אישית מצוינים כשיוצרים מוצר API). אפשר להשתמש במאפיינים מותאמים אישית של מוצר API בתוכניות תמחור שונות. לדוגמה, אם מגדירים תוכנית תמחור שבה מחייבים את המפתח על כל עסקה, אפשר להגדיר את התעריף של התוכנית על סמך מאפיין מותאם אישית כמו מספר הבייטים שמועברים בעסקה.
ניהול של חבילת מוצרי API באמצעות ה-API
אפשר להוסיף או למחוק מוצר API מחבילת מוצרי API באמצעות ה-API, כמו שמתואר בקטעים הבאים.
הוספת מוצר API לחבילת מוצרי API
כדי להוסיף מוצר API לחבילת מוצרי API, שולחים בקשת POST אל
organizations/{org_name}/monetization-packages/{package_id}/products/{product_id},
כאשר {org_name} מציין את שם הארגון, {package_id} מציין את שם חבילת מוצרי ה-API ו-{product_id} מציין את מזהה מוצר ה-API.
לדוגמה:
$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password
הוספת מוצר API לחבילת מוצרי API עם תוכניות תמחור ספציפיות למוצר API
כדי להוסיף מוצר API לחבילת מוצרי API שמוגדרות בה תוכניות תמחור ספציפיות למוצר API (כרטיס תמחור או חלוקת הכנסות), שולחים בקשת POST אל
organizations/{org_name}/monetization-packages/{package_id}/products/{product_id},
כאשר {org_name} מציין את שם הארגון, {package_id} מציין את שם חבילת מוצרי ה-API ו-{product_id} מציין את מזהה מוצר ה-API.
צריך להעביר את פרטי תוכנית התמחור של מוצר ה-API החדש בגוף הבקשה. חוץ ממערך ratePlanRates, הערכים של תוכנית התמחור צריכים להיות זהים לאלה שצוינו לכל מוצרי ה-API האחרים. מידע נוסף על מאפייני תוכניות התמחור שאפשר להגדיר זמין במאמר מאפייני הגדרה של תוכניות תמחור.
לדוגמה:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"ratePlan": [
{
"id": "mypackage_rateplan1",
"ratePlanDetails": [
{
"currency": {
"id": "usd"
},
"duration": 1,
"durationType": "MONTH",
"meteringType": "UNIT",
"organization" : {
"id": "{org_name}",
"paymentDueDays": "30",
"ratePlanRates": [
{
"rate": "1.99",
"startUnit": "0",
"type": "RATECARD"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}
]
}
]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password
מחיקת מוצר API מחבילת מוצרי API
כדי למחוק מוצר API מחבילת מוצרי API, שולחים בקשת DELETE אל organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, כאשר {org_name} מציין את שם הארגון, {package_id} מציין את שם חבילת מוצרי ה-API ו-{product_id} מציין את מזהה מוצר ה-API.
לדוגמה:
$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password
צפייה בחבילות מוצרים של API באמצעות ה-API
אפשר לאחזר חבילת מוצרי API ספציפית או את כל חבילות מוצרי ה-API בארגון. אפשר גם לאחזר חבילות של מוצרי API שכוללות עסקאות בטווח תאריכים מסוים, כלומר רק חבילות שמשתמשים מפעילים אפליקציות שנותנות גישה לממשקי API בחבילות האלה בטווח תאריכים מסוים.
צפייה בחבילת מוצרי API ספציפית: כדי לאחזר חבילת מוצרי API ספציפית, שולחים בקשת GET אל /organizations/{org_name}/monetization-packages/{package_id}, כאשר {package_id} הוא מזהה חבילת מוצרי ה-API (המזהה מוחזר בתגובה כשיוצרים את חבילת מוצרי ה-API). לדוגמה:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment_messaging_package" \
-u email:password
צפייה בכל חבילות המוצרים של ה-API: כדי לאחזר את כל חבילות המוצרים של ה-API בארגון, שולחים בקשת GET אל /organizations/{org_name}/monetization-packages. לדוגמה:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password
אפשר להעביר את הפרמטרים הבאים של השאילתה כדי לסנן את התוצאות:
| פרמטר שאילתה | תיאור |
|---|---|
all |
דגל שמציין אם להחזיר את כל חבילות מוצרי ה-API. אם הערך הוא false, מספר חבילות המוצרים של ה-API שמוחזרות בכל דף מוגדר על ידי פרמטר השאילתה size. ברירת המחדל היא false. |
size |
מספר חבילות מוצרי ה-API שמוחזרות בכל דף. ברירת המחדל היא 20. אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
page |
מספר הדף שרוצים להחזיר (אם התוכן מחולק לדפים). אם פרמטר השאילתה all מוגדר לערך true, המערכת מתעלמת מהפרמטר הזה. |
התגובה לצפייה בכל חבילות המוצרים של ה-API בארגון אמורה להיראות כך (מוצג רק חלק מהתגובה):
{ "monetizationPackage" : [ { "description" : "payment messaging package", "displayName" : "Payment Messaging Package", "id" : "payment_messaging_package", "name" : "Payment Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" }, { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, { "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "Payment", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" } ], "totalRecords" : 3 }
צפייה בחבילות מוצרים של API עם עסקאות: כדי לאחזר חבילות מוצרים של API עם עסקאות בטווח תאריכים מסוים, שולחים בקשת GET אל /organizations/{org_name}/packages-with-transactions. כששולחים את הבקשה, צריך לציין כפרמטרים של שאילתה תאריך התחלה ותאריך סיום לטווח התאריכים. לדוגמה, הבקשה הבאה מאחזרת חבילות של מוצרי API עם טרנזקציות במהלך חודש אוגוסט 2013.
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password
התשובה אמורה להיראות כך (מוצג רק חלק מהתשובה):
{ "monetizationPackage" : [ { "description" : "Payment Package", "displayName" : "Payment Package", "id" : "payment_package", "name" : "Payment Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "payment api product", "displayName" : "payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, { "description" : "messaging package", "displayName" : "Messaging Package", "id" : "messaging_package", "name" : "Messaging Package", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "customAtt2Name" : "response size", "customAtt3Name" : "content-length", "description" : "messaging api product", "displayName" : "messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "status == 'SUCCESS'" } ], "status" : "CREATED" }, ... } ] }
צפייה בחבילות של מוצרי API שאושרו על ידי מפתח או חברה שמשתמשים ב-API
כדי לראות את חבילות מוצרי ה-API שהתקבלו על ידי מפתח או חברה ספציפיים, שולחים בקשת GET לממשקי ה-API הבאים, בהתאמה:
-
/organizations/{org_name}/developers/{developer_id}/monetization-packages, כאשר {developer_id} הוא המזהה (כתובת האימייל) של המפתח. -
/organizations/{org_name}/companies/{company_id}/monetization-packages, כאשר {company_id} הוא מזהה החברה.
כששולחים את הבקשה, אפשר לציין את פרמטרים השאילתה הבאים:
| פרמטר שאילתה | תיאור | ברירת מחדל |
|---|---|---|
current |
דגל שמציין אם לאחזר רק חבילות פעילות של מוצרי API (current=true) או את כל החבילות (current=false). כל התוכניות לתמחור בחבילה פעילה נחשבות לזמינות. |
current=false |
allAvailable |
דגל שמציין אם לאחזר את כל חבילות מוצרי ה-API הזמינות (allAvailable=true) או רק את חבילות מוצרי ה-API שזמינות במיוחד למפתח או לחברה (allAvailable=false). כל החבילות הזמינות הן חבילות מוצרי ה-API שזמינות למפתח או לחברה שצוינו, בנוסף למפתחים או לחברות אחרים. חבילות של מוצרי API שזמינות רק לחברה או למפתח מסוימים מכילות רק תוכניות תמחור שזמינות באופן בלעדי לחברה או למפתח האלה. |
allAvailable=true |
לדוגמה, הבקשה הבאה מאחזרת את כל חבילות המוצרים של ה-API שאושרו על ידי מפתח ספציפי:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password
הבקשה הבאה מאחזרת רק חבילות API פעילות שאושרו על ידי חברה ספציפית:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password
מחיקת חבילת מוצרי API באמצעות API
אפשר למחוק חבילת מוצרי API רק אם לא הוגדרו בה תוכניות תמחור.
כדי למחוק חבילת מוצרי API שלא הוגדרו לה תוכניות תמחור, שולחים בקשת DELETE אל organizations/{org_name}/monetization-packages/{package_id}, כאשר {org_name} מציין את שם הארגון ו-{package_id} מציין את שם חבילת מוצרי ה-API.
לדוגמה:
$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}" \
-u email:password
מאפייני הגדרה של חבילת מוצרים של API עבור ה-API
אלה אפשרויות ההגדרה של חבילת מוצרי ה-API שמוצגות ב-API:
| שם | תיאור | ברירת מחדל | חובה? |
|---|---|---|---|
description |
תיאור של חבילת מוצרי ה-API. |
לא רלוונטי | כן |
displayName |
השם שיוצג לחבילת מוצרי ה-API (לדוגמה, בקטלוג של חבילות API). |
לא רלוונטי | כן |
name |
השם של חבילת מוצרי ה-API. |
לא רלוונטי | כן |
organization |
הארגון שמכיל את חבילת מוצרי ה-API. |
לא רלוונטי | לא |
product |
מערך של מוצר אחד או יותר בחבילת מוצרי ה-API. |
לא רלוונטי | לא |
status |
אינדיקטור סטטוס של חבילת מוצרי ה-API. הערך של אינדיקטור הסטטוס יכול להיות אחד מהערכים הבאים: CREATED, ACTIVE, INACTIVE. |
לא רלוונטי | כן |