רישום מפתחי אפליקציות

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

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

מבוא

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

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

איך רושמים מפתחי אפליקציות

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

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

המלצות לניהול חשבונות פיתוח בפורטלים למפתחים

מומלץ לנהל את חשבונות המפתחים ישירות בפורטל המפתחים.

אם אתם משתמשים בפורטל המשולב, זו הדרך היחידה לוודא שחשבונות הפיתוח בפורטל המשולב וב-Edge יישארו מסונכרנים.

אם אתם משתמשים בפורטל למפתחים שמבוסס על Drupal, ניהול חשבונות מפתחים ישירות בפורטל למפתחים מספק את היתרונות הבאים:

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

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

• כל שינוי שמתבצע בחשבון המפתח בפורטל נשלח אוטומטית אל Edge.

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

הדף 'מפתחים'

גישה לדף Developers (מפתחים) ועיון בו באמצעות ממשק המשתמש של Edge וממשק המשתמש החדש של Edge.

הוספת מפתח

כדי להוסיף מפתח:

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

צפייה בפרטי המפתח ועריכתם

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

כדי לראות ולערוך את פרטי המפתח:

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

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

4. בשדה 'סטטוס' מפעילים או משביתים את המפתח.
   מידע נוסף מופיע במאמר הפעלה והשבתה של מפתח.

ב-Apigee Edge for Public Cloud, מערכת Edge שומרת במטמון את הישויות הבאות למשך 180 שניות לפחות אחרי הגישה לישויות.

• אסימוני גישה מסוג OAuth. כלומר, יכול להיות שאסימון שבוטל עדיין יפעל למשך שלוש דקות לכל היותר, עד שתוקף המטמון שלו יפוג.
• ישויות של Key Management Service‏ (KMS) (אפליקציות, מפתחים, מוצרי API).
• מאפיינים מותאמים אישית בטוקנים של OAuth ובסוגי ישויות של KMS.

ניהול מאפיינים מותאמים אישית למפתחים

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

כדי לנהל מאפיינים מותאמים אישית:

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

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

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

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

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

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

ייצוא נתוני פרסום

מייצאים את נתוני הפרסום הבאים כקובץ ערכים מופרדים בפסיקים (CSV):

• פרטי מפתח
• פרטים על מפתחים, אפליקציות ומוצרי API

כדי לייצא נתוני פרסום:

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

נתוני הפרסום שנבחרו יורדו כקובץ CSV.

מחיקת מפתח

כדי למחוק מפתח:

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

סנכרון מפתחי אפליקציות בין הפורטל לבין Edge

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

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

• ‫Drupal 10: סנכרון מפתחים עם Apigee Edge
• ‫Drupal 7: סנכרון מפתחי אפליקציות בין הפורטל לבין Edge

קיבוץ מפתחים בחברות

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

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

הגדרת מאפייני מונטיזציה

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

שם השדה	שם המאפיין המותאם אישית	תיאור
כתובת	MINT_DEVELOPER_ADDRESS	כתובת המפתח, כולל השדות הבאים: כתובת (שורות 1 ו-2), עיר, מדינה (State), מיקוד ומדינה.
פרופיל חיוב	MINT_BILLING_PROFILE	מחזור החיובים של הארגון. הערכים התקפים כוללים: ‫PRORATED: החיוב מבוסס על מספר הימים שבהם נעשה שימוש במוצר API בחודש קלנדרי. ‫CALENDAR_MONTH: החיוב מתבצע מדי חודש.
סוג החיוב	MINT_BILLING_TYPE	מודל התשלומים למפתחים שמשמש לחיוב. הערך יכול להיות אחד מהערכים הבאים: ‫PREPAID: המפתח משלם מראש על השימוש במוצר API. הכסף מנוכה מהיתרה של המפתח כשהוא משתמש במוצר ה-API. המפתחים צריכים לדאוג שיהיה להם היתרה מההפקדה מספקת כדי לרכוש את מוצר ה-API. ‫POSTPAID: המפתחים מחויבים מדי חודש (באמצעות חשבונית) על השימוש במוצרי API. המפתח משלם על השימוש במוצרי API בהתאם לתנאי התשלום שמוגדרים בתוכניות שכלולות בחשבונית. BOTH: תומך בשני סוגי החיוב. ברירת המחדל היא PREPAID. מידע נוסף זמין במאמר הגדרה של סוגי חיוב מראש וחיוב לאחר השימוש באמצעות ה-API.
קטגוריה	MINT_DEVELOPER_CATEGORY	קטגוריית המפתחים שאליה רוצים להוסיף את המפתח. קטגוריית מפתחים היא קבוצה של מפתחים או חברות עם מאפיינים דומים. מידע נוסף מופיע במאמר בנושא ניהול קטגוריות של מפתחים.
מזהה החברה	MINT_COMPANY_ID	מזהה החברה, אם רלוונטי. מידע נוסף מופיע במאמר בנושא קיבוץ מפתחים בחברות.
סוג המפתח	MINT_DEVELOPER_TYPE	נכס כזה לא נמצא בשימוש ב-Apigee. סוג המפתח. הערכים התקפים כוללים: TRUSTED או UNTRUSTED
הוא סוכן	MINT_IS_BROKER	דגל שמציין אם ההכנסה מבוססת על נטו.
שם חוקי	MINT_DEVELOPER_LEGAL_NAME	השם החוקי של המפתח שישמש בכל הדוחות. הערה: חובה לציין את המאפיין הזה אם המפתח לא משויך לחברה ורוצה להירשם לתוכנית תמחור שפורסמה.
חיוב עצמי	MINT_HAS_SELF_BILLING	סימון שמציין אם חשבוניות לחיוב עצמי מופעלות. אם האפשרות הזו מופעלת (true), המונטיזציה יוצרת חשבונית לחיוב עצמי במקום דוח חלוקת הכנסות. חשבונית לחיוב עצמי היא מסמך פיננסי שמפרט את הסכום לתשלום למפתח. היא משמשת כחשבונית לספק ה-API בשם המפתח.
מספר אישור פטור ממס	MINT_TAX_EXEMPT_AUTH_NO	מספר פטור ממס ממשלתי, אם רלוונטי.
שיעור מס	MINT_APPROX_TAX_RATE	שיעור המס המשוער של המפתח. מציינים ערך עשרוני עם מספר מקסימלי של 3 תווים לפני הנקודה העשרונית ו-4 תווים אחרי הנקודה העשרונית.

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

ניהול מפתחים באמצעות ממשקי Developer API.

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