ניהול חברות ומפתחים באמצעות Edge

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

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

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

• אם מפתחים שמשתמשים במונטיזציה צריכים פרטי כניסה כדי לגשת לממשק המשתמש או ל-API של Edge, קודם הם צריכים ליצור חשבון אדמין משלהם ב-Apigee.
• אם אתם רוצים ליצור מפתחי בדיקה שלא צריכים פרטי כניסה (לדוגמה, אם אתם רוצים לבצע קריאות ל-API עם מפתחי בדיקה פיקטיביים), אתם לא צריכים חשבונות Apigee.

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

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

ניהול חברות באמצעות ממשק המשתמש

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

הדף 'חברות'

נכנסים לדף 'חברות', כמו שמתואר בהמשך.

הוספת חברה

כדי להוסיף חברה:

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

   שדות החובה כוללים:

   • שם החברה
   • אדמין (המשתמש שהוא האדמין הראשי של החברה)
   • סוג החיוב

   בהתאם להגדרות החיוב של המונטיזציה, סוג החיוב עשוי להיות מוגדר כברירת מחדל ל-PREPAID או ל-POSTPAID. מידע נוסף זמין במאמר הגדרת סוגי חיוב מראש וחיוב לאחר שימוש באמצעות ה-API.

4. מוסיפים מפתח אחד או יותר לחברה.
   1. בקטע Developers (מפתחים), מזינים מחרוזת בשדה Add Developer (הוספת מפתח) כדי להציג את רשימת המפתחים שתואמים למחרוזת.
   2. בוחרים מפתח מהרשימה הנפתחת.
   3. חוזרים על הפעולה כדי להוסיף עוד מפתחים לחברה.
5. מוסיפים מאפיין מותאם אישית אחד או יותר.
   1. בקטע 'מאפיינים בהתאמה אישית', לוחצים על + חדש.
   2. מזינים את השם והערך של המאפיין המותאם אישית.
   3. חוזרים על הפעולה כדי להוסיף עוד מאפיינים מותאמים אישית לחברה.
6. לוחצים על יצירת חברה.

הפעלה והשבתה של חברה

כדי להפעיל או להשבית חברה:

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

עריכת חברה

כדי לערוך חברה:

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

מחיקת חברה

כדי למחוק חברה:

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

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

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

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

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

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

ניהול תפקידי מפתחים באמצעות ה-API

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

יצירת תפקיד מפתח

כדי ליצור תפקיד למפתחים, שולחים בקשת POST אל organizations/{org_name}/developer-roles. כששולחים את הבקשה, צריך לציין בגוף הבקשה את השם והתיאור של התפקיד ואת פרטי הזיהוי של הארגון. לדוגמה:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}"
   }
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

אחזור תפקידי מפתחים

כדי לאחזר תפקידי מפתחים, שולחים בקשת GET אל organizations/{org_id}/developer-roles. לדוגמה:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

התשובה אמורה להיראות כך (מוצג רק חלק מהתשובה):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

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

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

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

כדי לקבל את שיעור המס הנוכחי של מפתח, שולחים בקשת GET אל organizations/{org_name}/tax-engine. כששולחים את הבקשה, צריך לציין את מזהה המפתח כפרמטר שאילתה. לדוגמה:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

התגובה אמורה להיראות כך:

0.09

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

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

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