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

אתם צופים במסמכי התיעוד של Apigee Edge.
אפשר לעבור אל מסמכי התיעוד של Apigee X.
מידע

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

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

כדי לגשת לדף Developer Categories (קטגוריות מפתחים), משתמשים בממשק המשתמש של Edge או בממשק המשתמש הקלאסי של Edge, כמו שמתואר בקטעים הבאים.

ממשק משתמש של Edge

כדי לגשת לדף 'פיתוח קטגוריות':

  1. מתחברים אל apigee.com/edge.
  2. בסרגל הניווט הימני, בוחרים באפשרות פרסום > מונטיזציה > קטגוריות למפתחים.

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

כפי שמודגש באיור, בדף 'קטגוריות מפתחים' אפשר:

Classic Edge (ענן פרטי)

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

  1. מתחברים אל http://ms-ip:9000, כאשר ms-ip היא כתובת ה-IP או שם ה-DNS של צומת שרת הניהול.
  2. בסרגל הניווט העליון, בוחרים באפשרות פרסום > קטגוריות למפתחים.

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

בדף 'קטגוריות מפתחים' אפשר:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

כששולחים את הבקשה, צריך לציין במטען הייעודי (payload) גם את הקטגוריה 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

המזהה של קטגוריית המפתחים שאליה המפתח נוסף.

לא רלוונטי כן, כדי להגדיר את קטגוריית המפתחים.