כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
קטגוריית מפתחים היא קבוצה של מפתחים או חברות עם מאפיינים דומים, שמאפשרת להגדיר את המונטיזציה כך שיפעלו בקטגוריה הספציפית הזו. לדוגמה, אפשר ליצור תוכניות תעריפים שיחולו על כל המפתחים שמפתחים אפליקציות לחלוקת הכנסות. לשם כך, צריך ליצור קטגוריית מפתחים שנקראת 'Revenue_sharing' ולהוסיף אליה מפתחים. מידע נוסף על יצירת תוכניות תעריפים עם קטגוריות של מפתחים
סיור בדף 'קטגוריות למפתחים'
ניתן לגשת לדף 'קטגוריות מפתחים' באמצעות ממשק המשתמש של Edge או הממשק הקלאסי של Edge, כפי שמתואר בסעיפים הבאים.
ממשק המשתמש של Edge
כדי לגשת לדף 'פיתוח קטגוריות':
- מתחברים לאתר apigee.com/edge.
- בסרגל הניווט הימני, בוחרים באפשרות פרסום > מונטיזציה > קטגוריות מפתחים.
הדף 'קטגוריות למפתחים' מוצג.
כפי שמודגש באיור, הדף 'קטגוריות מפתחים' מאפשר לך:
Classic Edge (ענן פרטי)
כדי לגשת לדף 'פיתוח קטגוריות' באמצעות ממשק המשתמש הקלאסי של Edge:
- נכנסים אל
http://ms-ip:9000
. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול. - בסרגל הניווט העליון, בוחרים באפשרות פרסום > קטגוריות מפתחים.
הדף 'קטגוריות למפתחים' מוצג.
הדף 'קטגוריות מפתחים' מאפשר לך:
הוספה של קטגוריית מפתחים
כדי להוסיף קטגוריית מפתח באמצעות ממשק המשתמש:
- נכנסים לדף 'פיתוח קטגוריות'.
- לוחצים על + קטגוריית מפתח.
- מזינים שם לקטגוריה החדשה ותיאור קצר.
- לוחצים על יצירת קטגוריית מפתח.
הוספת חברה לקטגוריית מפתחים
יש להוסיף חברה לקטגוריית מפתחים. חברה יכולה להשתייך לקטגוריית מפתחים אחת בלבד.
כדי להוסיף חברה לקטגוריית מפתחים:
- בסרגל הניווט העליון בוחרים באפשרות פרסום > חברות.
- בוחרים את החברה שרוצים להוסיף לקטגוריית המפתחים.
- לוחצים על עריכה בדף החברה.
- בוחרים את קטגוריית המפתחים של החברה.
- לוחצים על שמירה.
עריכה של קטגוריית מפתחים
כדי לערוך קטגוריית מפתח באמצעות ממשק המשתמש:
- נכנסים לדף 'פיתוח קטגוריות'.
- מציבים את הסמן מעל קטגוריית המפתחים שרוצים לערוך ולוחצים על .
- מזינים את קטגוריית המפתחים.
- לוחצים על עדכון קטגוריית המפתח.
מחיקה של קטגוריית מפתחים
כדי למחוק קטגוריית מפתח באמצעות ממשק המשתמש:
- נכנסים לדף 'פיתוח קטגוריות'.
- מציבים את הסמן מעל קטגוריית המפתח שרוצים לערוך.
- לוחצים על .
- לוחצים על מחיקה כדי לאשר את הפעולה.
ניהול קטגוריות של מפתחים באמצעות ה-API
ניהול קטגוריות של מפתחים באמצעות ה-API, כפי שמתואר בקטעים הבאים.
הוספה של קטגוריית מפתח באמצעות ה-API
כדי להוסיף קטגוריית מפתחים, יש לשלוח בקשת POST אל
/mint/organizations/{org_name}/developer-categories
.
כששולחים את הבקשה, צריך לציין את הקטגוריות name
ואת description
במטען הייעודי (payload). לדוגמה:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Content-Type:application/json" \ -d '{ "name": "Gold", "description": "Gold membership" }' \ -u email:password
התגובה אמורה להיראות כך:
{ "description" : "Gold membership", "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0", "name" : "Gold" }
הוספה של מפתח או חברה לקטגוריית מפתחים באמצעות ממשק ה-API
הוספה של מפתח או חברה לקטגוריית מפתחים כשמוסיפים או עורכים את החברה או המפתח על ידי שליחת בקשת POST למשאבים הבאים, בהתאמה:
- /organizations/{org_name}/companies
- /organizations/{org_name}/developers
כדי להוסיף מפתח או חברה לקטגוריית מפתחים כשאתם עורכים את שם החברה או המפתח, עליכם לשלוח בקשת PUT למשאבים הבאים, בהתאמה:
- /organizations/{org_name}/companies/{company_id}
- /organizations/{org_name}/developers/{developer_id}
חברה או מפתח יכולים להשתייך לקטגוריית מפתחים אחת בלבד.
צריך לציין את MINT_DEVELOPER_CATEGORY
כמאפיין בגוף הבקשה, עם
הערך הפנימי של הקטגוריה. לדוגמה, בעקבות הבקשה הבאה יתווסף מפתח
שכבר קיים לקטגוריית המפתחים בשם 'זהב', שהמזהה שלה הוא aa6f960a-d9fd-416e-be39-c071418aabd0
.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \ -H "Content-Type: application/json" \ -d '{ "email" : "developer@apigee.com", "developerId" : "K4jW2QLjZ1h8GFA8", "firstName" : "Dev", "lastName" : "One", "userName" : "devone", "attributes" : [ { "name" : "MINT_REGISTRATION_ID", "value" : "dev1" }, { "name" : "MINT_DEVELOPER_LEGAL_NAME", "value" : "DEV ONE" }, { "name" : "MINT_DEVELOPER_TYPE", "value" : "TRUSTED" }, { "name" : "MINT_BILLING_TYPE", "value" : "PREPAID" }, { "name" : "MINT_IS_BROKER", "value" : "TRUE" }, { "name" : "MINT_DEVELOPER_CATEGORY", "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0" }, { "name" : "MINT_DEVELOPER_ADDRESS", "value" : "{ "address1": "Dev One Address", "city": "Pleasanton", "country": "US", "isPrimary": "true", "state": "CA", "zip": "94588" }" } }' \ -u email:password
הצגת קטגוריות של מפתחים באמצעות ה-API
להציג קטגוריית מפתח ספציפית או את כל קטגוריות המפתחים בארגון.
כדי להציג קטגוריית מפתחים ספציפית, יש לשלוח בקשת GET אל
/mint/organizations/{org_name}/developer-categories/{category_id}
, כאשר
{category_id}
הוא המזהה של קטגוריית המפתחים (המזהה מוחזר
בתגובה כשמוסיפים את קטגוריית המפתחים). לדוגמה:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
כדי להציג את כל הקטגוריות של מפתחי ה-API בארגון, יש לשלוח בקשת GET אל
/mint/organizations/{org_id}/developer-categories
. לדוגמה:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Accept:application/json" \ -u email:password
עריכה של קטגוריית מפתח באמצעות ה-API
עריכה של קטגוריית פיתוח על ידי שליחת בקשת PUT אל
/mint/organizations/{org_name}/developer-categories/{category_id}
, כאשר
{category_id}
הוא הזיהוי של הקטגוריה לעדכון. צריך לציין בגוף הבקשה את ההגדרות המעודכנות ואת המזהה של קטגוריית
המפתח. לדוגמה, בעקבות הבקשה הבאה מתבצעת עריכה של התיאור של קטגוריית מפתחים:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Content-Type: application/json" \ -d '{ "id": "aa6f960a-d9fd-416e-be39-c071418aabd0", "description": "Premium membership" }' \ -u email:password
מחיקה של קטגוריית מפתחים באמצעות ה-API
כדי למחוק קטגוריית מפתחים, יש לשלוח בקשת DELETE אל
/mint/organizations/{org_name}/developer-categories/{category_id}
, כאשר
{category_id}
הוא המזהה של קטגוריית המפתחים שיש למחוק. לדוגמה:
curl -X DELETE "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
מאפייני הגדרת קטגוריות למפתחים ל-API
הטבלה הבאה מסכמת את מאפייני התצורה שניתן להגדיר באמצעות ה-API.
שם | התיאור | ברירת המחדל | חובה? |
---|---|---|---|
name |
שם הנכס. מוגדר ל-MINT_DEVELOPER_CATEGORY. |
לא רלוונטי | כן |
value |
המזהה של קטגוריית המפתח שאליה נוסף המפתח. |
לא רלוונטי | כן, כדי להגדיר את קטגוריית המפתח. |