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

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

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

מבוא

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

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

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

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

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

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

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

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

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

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

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

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

היכרות עם הדף 'מפתחים'

אפשר לגשת לדף Developers ולחקור אותו באמצעות ממשק המשתמש של Edge וממשק המשתמש הקלאסי של Edge.

Edge

כדי לגשת לדף Developers באמצעות ממשק המשתמש של Edge:

  1. נכנסים לאתר apigee.com/edge.
  2. בסרגל הניווט הימני בוחרים באפשרות פרסום > מפתחים.

הדף 'מפתחים' מוצג.

כפי שמודגש באיור, הדף 'מפתחים' מאפשר לך:

Classic Edge (ענן פרטי)

כדי לגשת לדף Developers באמצעות ממשק המשתמש הקלאסי של Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בוחרים באפשרות פרסום > מפתחים בסרגל הניווט העליון.

הדף 'מפתחים' מוצג.

הוספת מפתח

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

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

הצגה ועריכה של פרטי מפתח

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

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

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

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

  • אסימוני גישה מסוג OAuth. המשמעות היא שאסימון שבוטל יוכל בכל זאת לפעול במשך עד שלוש דקות, עד שיפוג התוקף של מגבלת המטמון שלו.
  • ישויות של שירות ניהול מפתחות (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, יש לעיין בקטעים הבאים:

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

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

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

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

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

שם השדה שם מאפיין מותאם אישית תיאור
כתובת MINT_DEVELOPER_ADDRESS

כתובת של המפתח, כולל השדות הבאים: כתובת (שורות 1 ו-2), עיר, מדינה, מיקוד ומדינה.

פרופיל חיוב MINT_BILLING_PROFILE

מחזור החיובים של הארגון. הערכים החוקיים כוללים:

  • PRORATED: החיוב מבוסס על מספר הימים שבהם נעשה שימוש במוצר API בחודש קלנדרי.
  • CALENDAR_MONTH: החיוב מתבצע על בסיס חודשי.
סוג החיוב MINT_BILLING_TYPE

מודל התשלום של המפתח המשמש לחיוב. הערך יכול להיות אחד מהבאים:

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

למידע נוסף, ראו הגדרת סוגי חיוב בתשלום מראש ותשלום לאחר השימוש (postpay) באמצעות ה-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

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

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