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

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

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

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

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

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

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

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

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

הדף 'חברות'

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

הוספת חברה

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

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

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

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

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

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

הפעלה וביטול הפעלה של חברה

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

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 למונטיזציה. בטבלה מפורט גם איפה אפשר למצוא הוראות מפורטות לביצוע המשימות האלה.