סיכום השינויים לפרסום

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

פרסום הוא התהליך של הפיכת ממשקי ה-API לזמינים למפתחי אפליקציות לשימוש.

הערה: הסרטון הזה צולם בגרסה קודמת של ממשק המשתמש של Apigee, אבל המושגים עדיין רלוונטיים.

סרטון: בסרטון הבא מוצג מבוא כללי לפרסום באמצעות API.

פרסום ממשקי API כולל את המשימות הבאות, שמתוארות בנושא הזה:

1. יוצרים את מוצרי ה-API שכוללים את ה-API שלכם.
2. רישום מפתחי אפליקציות.
3. רישום אפליקציות למפתחים.
4. לספק תיעוד ותמיכה מהקהילה לממשקי ה-API.

משימה 1: יצירת מוצר API

המשימה הראשונה בתהליך הפרסום היא ליצור מוצר API. מוצר API הוא אוסף של משאבי API שמוצעים כמארז למפתחי אפליקציות לשימוש. יוצרים מוצרי API באמצעות Apigee API או ממשק המשתמש. (במאמר מהו מוצר API? מוסבר מהם מוצרי API).

באיור הזה, ה-API מורכב משני מוצרים, שכל אחד מהם מכיל שלושה משאבי API.

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

• פרסום מוצר API חינמי שמאפשר גישת קריאה בלבד למשאבי ה-API שלו.
• השקת מוצר API שני במחיר הרצפה שמאפשר גישת קריאה/כתיבה לאותם משאבי API כמו בגרסה החינמית, אבל עם מגבלת גישה נמוכה, כמו 1,000 בקשות ביום.
• השקת מוצר API שלישי במחיר גבוה יותר שמאפשר גישת קריאה/כתיבה לאותו משאב API, אבל עם מגבלת גישה גבוהה.

חשוב לזכור ש-Apigee מאפשרת לכם ליצור מוצרי API שמתאימים לדרישות העסקיות של ממשקי ה-API שלכם.

מידע נוסף על יצירת מוצרי API זמין במאמר ניהול מוצרי API.

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

מפתח יוצר את האפליקציות שצורכות את ממשקי ה-API שלכם. מפתח אפליקציה נרשם ב-Apigee לפני שהוא יכול לרשום את האפליקציה שלו. כשהוא רושם את האפליקציה, הוא מקבל מפתח API שיאפשר לאפליקציה גישה ל-API.

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

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

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

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

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

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

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

כספקי API, אתם מחליטים איך אתם רוצים לרשום אפליקציות. אתם יכולים:

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

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

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

משימה 4: תיעוד ממשקי ה-API

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

אתם יכולים לבנות אתר משלכם כדי לפרוס את התיעוד, או אם יש לכם חשבון Apigee בתשלום, אתם יכולים להשתמש בפורטל Apigee Developer Services. הפורטל כולל תמיכה מובנית בתיעוד, בבלוגים, בפורומים ובסוגים אחרים של תוכן שנדרשים לתמיכה בקהילת המפתחים שלכם.

SmartDocs מאפשר לכם לתעד את מאמרי העזרה של ה-API בפורטל Developer Services באופן אינטראקטיבי לחלוטין. תיעוד אינטראקטיבי באמצעות SmartDocs מאפשר למשתמשי הפורטל:

• מידע על ה-API
• שליחת בקשה בזמן אמת ל-API
• הצגת תשובה בזמן אמת שמוחזרת מה-API

מידע נוסף מפורט בסעיפים הבאים:

• פורטל משולב: פרסום ממשקי API
• ‫Drupal 10: תיעוד של ממשקי ה-API