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

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

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

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

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

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

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

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

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

סיור בדף 'חברות'

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

הוספת חברה

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

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

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

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

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

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

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

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

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

עריכת חברה

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

1. נכנסים לדף החברה.
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 לארגונים/{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 למונטיזציה. בטבלה גם אפשר למצוא הוראות מפורטות לביצוע את המשימות האלה.