ניהול הקטגוריות למפתחים

אתם מציגים את מסמכי התיעוד של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

קטגוריית מפתחים היא קיבוץ של מפתחים או חברות עם מאפיינים דומים, שמאפשר לכם להגדיר את המונטיזציה כך שתופעל בקטגוריה הספציפית הזו. לדוגמה, אפשר ליצור תוכניות תמחור שתחול על כל המפתחים שמפתחים אפליקציות לחלוקת הכנסות, על ידי יצירת קטגוריית מפתחים בשם revenue_sharing והוספת מפתחים אליה. למידע נוסף על יצירת תוכניות תמחור עם קטגוריות למפתחים, ראו יצירת תוכניות תמחור.

הדף 'קטגוריות למפתחים'

נכנסים לדף 'קטגוריות מפתחים' באמצעות ממשק המשתמש של Edge או הממשק הקלאסי של Edge, כפי שמתואר בסעיפים הבאים.

הוספת קטגוריה למפתחים

כדי להוסיף קטגוריה של מפתחים באמצעות ממשק המשתמש:

1. נכנסים לדף Develop Categories.
2. לוחצים על + Developer Category.
3. מזינים שם לקטגוריה החדשה ותיאור קצר.
4. לוחצים על Create Developer Category (יצירת קטגוריה למפתחים).

הוספת חברה לקטגוריית מפתחים

מוסיפים חברה לקטגוריית מפתחים. חברה יכולה להשתייך רק לקטגוריית מפתחים אחת.

כדי להוסיף חברה לקטגוריית מפתחים:

1. בסרגל הניווט העליון, בוחרים באפשרות פרסום > חברות.
2. בוחרים את החברה שרוצים להוסיף לקטגוריית המפתחים.
3. בדף החברה, לוחצים על עריכה.
4. בוחרים את קטגוריית המפתחים של החברה.
5. לוחצים על שמירה.
   

עריכת קטגוריית מפתח

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

1. נכנסים לדף Develop Categories.
2. מציבים את הסמן מעל לקטגוריית המפתחים שרוצים לערוך ולוחצים על .
3. מזינים את קטגוריית המפתח.
4. לוחצים על עדכון קטגוריית המפתחים.

מחיקת קטגוריה של מפתחים

כדי למחוק קטגוריה של מפתחים באמצעות ממשק המשתמש:

1. נכנסים לדף Develop Categories.
2. מציבים את הסמן מעל קטגוריית המפתחים שרוצים לערוך.
3. לוחצים על .
4. לוחצים על מחיקה כדי לאשר את הפעולה.

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

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

הוספת קטגוריה של מפתח באמצעות ה-API

יש להוסיף קטגוריית מפתח על ידי שליחת בקשת POST אל /mint/organizations/{org_name}/developer-categories.

כששולחים את הבקשה, מציינים את הקטגוריות name ו-description בתוכן הייעודי. לדוגמה:

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 כמאפיין בגוף הבקשה, עם המזהה הפנימי של הקטגוריה בתור הערך. לדוגמה, הבקשה הבאה מוסיפה מפתח שכבר קיים לקטגוריית המפתחים 'Gold', שמזהה שלה הוא 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	המזהה של קטגוריית המפתחים שאליה המפתח נוסף.	לא רלוונטי	כן, כדי להגדיר את קטגוריית המפתח.