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

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

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

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

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

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

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

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

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

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

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

הוספת חברה

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

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

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

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

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

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

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

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

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

עריכת חברה

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

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

מחיקת חברה

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

1. נכנסים לדף 'חברות'.
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:

שם	התיאור	ברירת המחדל	חובה?
name	השם של תפקיד המפתח.	לא רלוונטי	כן
description	תיאור של תפקיד המפתח.	לא רלוונטי	כן

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

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