אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
פרסום הוא התהליך שבו ממשקי ה-API שלכם הופכים לזמינים לשימוש של מפתחי אפליקציות.
סרטון: הסרטון הבא מספק מבוא כללי לפרסום ממשקי API.
פרסום ממשקי API כולל את המשימות הבאות, שמתוארות בנושא הזה:
- יוצרים ב-Edge את מוצרי ה-API שמקבצים את ממשקי ה-API שלכם.
- הרשמה של מפתחי אפליקציות ב-Edge.
- הרשמה של אפליקציות למפתחים ב-Edge.
- לספק מסמכי עזרה ותמיכה מהקהילה לממשקי ה-API שלכם.
משימה 1: יצירת מוצר API ב-Edge
המשימה הראשונה בתהליך הפרסום היא ליצור מוצר API. מוצר API הוא אוסף של משאבי API שמוצעים כחבילה למפתחי אפליקציות לשימוש. יצירה של מוצרי API באמצעות ממשק ה-API או ממשק המשתמש לניהול של Edge. (מידע נוסף על מוצרי API זמין במאמר מהו מוצר API?).
בתרשים הזה, ה-API מורכב משני מוצרים, שכל אחד מהם מכיל שלושה משאבי API.
כספק API, אתם אחראים לפתח את ממשקי ה-API ומוצרי ה-API כך שיתאימו לבקרת גישה, להגבלות שימוש ולדרישות עסקיות אחרות. לדוגמה, תוכלו:
- השקת מוצר API בחינם שמאפשר גישה לקריאה בלבד למשאבי ה-API שלו.
- להשיק מוצר API שני במחיר נמוך שמאפשר גישה לקריאה/כתיבה לאותם משאבי API כמו בגרסה החינמית, אבל עם מכסת גישה נמוכה, למשל 1,000 בקשות ביום.
- משיקים מוצר API שלישי במחיר גבוה יותר שמאפשר גישה לקריאה/כתיבה לאותו משאב API, אבל עם מגבלת גישה גבוהה.
חשוב לזכור ש-Edge מספק לכם את הגמישות ליצור מוצרי API שתואמים לדרישות העסקיות של ממשקי ה-API שלכם.
מידע נוסף על יצירת מוצרי API זמין במאמר יצירת מוצרי API.
משימה 2: רישום של מפתח אפליקציות ב-Edge
מפתחים יוצרים את האפליקציות שמשתמשות בממשקי ה-API שלכם. מפתח אפליקציה צריך להירשם ב-Apigee Edge כדי שיוכל לרשום את האפליקציה שלו. כשמפתחים את האפליקציה, מקבלים מפתח API שיעניק לאפליקציה גישה ל-API.
תהליך הרישום של האפליקציה מאפשר לכם לקבוע למי תהיה גישה לממשקי ה-API שלכם. אתם יכולים למחוק מפתח אפליקציה בכל שלב, וכך לבטל את תוקף כל מפתחות ה-API שמשויכים למפתח הזה, וכתוצאה מכך למנוע ממנו גישה לממשקי ה-API שלכם.
בתור ספק API, אתם מחליטים איך לרשום מפתחים. לדוגמה, אפשר להשתמש בתהליך רישום ידני שבו מפתח פוטנציאלי צריך ליצור איתכם קשר כדי להירשם. המפתח הפוטנציאלי צריך לספק את כל הפרטים הנדרשים, כמו כתובת אימייל, שם פרטי, שם משפחה ושם החברה. אם תאשרו את הבקשה של המפתח, תוכלו להשתמש בממשק המשתמש לניהול של Edge כדי לרשום את המפתח באופן ידני. מידע נוסף זמין במאמר ניהול מפתחי אפליקציות.
ב-Apigee יש גם כלים שאפשר להשתמש בהם כדי להפוך את תהליך הרישום של המפתחים לאוטומטי. לדוגמה:
- שימוש ב-API לניהול של Apigee Edge כדי לשלב פונקציונליות של רישום באתר הקיים. Edge Management API הוא ממשק API ל-REST שאפשר להשתמש בו כדי לבצע את כל ההיבטים של תהליך הרישום של המפתחים. מידע נוסף זמין במאמר שימוש ב-Edge Management API לפרסום ממשקי API.
- אתם יכולים להשתמש בפורטל של שירותי הפיתוח של Apigee כדי לרשום מפתחים. בפורטל יש תמיכה מובנית ברישום מפתחים, אבל יש בו גם תכונות רבות אחרות לתמיכה בממשקי ה-API שלכם. למידע נוסף, ראו מהו פורטל למפתחים?
משימה 3: רישום אפליקציית פיתוח ב-Edge
כדי שאפליקציה תוכל לגשת לממשקי ה-API שלכם, היא צריכה להיות רשומה ב-Edge. עם זאת, רק מפתחים רשומים יכולים לרשום אפליקציה ב-Edge.
במהלך רישום האפליקציה, המפתח בוחר מוצר API אחד או יותר. לדוגמה, תוכלו לפרסם כמה מוצרי API שתואמים לסוגים שונים של שירותים ותוכניות תמחור. לאחר מכן, מפתח האפליקציה יוכל לבחור מתוך רשימת מוצרי ה-API הזמינים.
בתגובה לרישום האפליקציה ב-Edge, המערכת מקצה לאפליקציה מפתח API ייחודי. האפליקציה חייבת להעביר את מפתח ה-API הזה כחלק מכל בקשה למשאב API. המפתח מאומת, ואם הוא תקף, הבקשה מאושרת. אתם, בתור ספקי השירות, יכולים לבטל את המפתח בכל שלב כדי לאפליקציה לא תהיה יותר גישה לממשקי ה-API שלכם.
כספק API, אתם מחליטים איך רוצים לרשום אפליקציות. תוכל:
- להשתמש בתהליך ידני שבו המפתח צריך ליצור קשר עם הארגון כדי לרשום את האפליקציה שלו. בתגובה, שולחים למפתח את מפתח ה-API, אולי באימייל.
- שימוש ב-Edge Management API כדי לשלב באתר את הפונקציונליות של רישום האפליקציה ואת העברת המפתחות.
- בחשבון Edge בתשלום, אפשר להשתמש בפורטל Apigee Developer Services, שכולל תמיכה מובנית ברישום אפליקציות ובמסירה של מפתחות API.
מידע נוסף זמין במאמר רישום אפליקציות וניהול מפתחות API.
משימה 4: תיעוד ממשקי ה-API
שיקול חשוב לפרסום מוצרי API הוא מתן תיעוד ומנגנון למשוב ממפתחים. יותר ויותר מפתחים משתמשים בפורטלים למפתחים עם תכונות של פרסום ברשתות חברתיות כדי לתקשר עם קהילת הפיתוח. זה כולל העברת תוכן סטטי, כמו מסמכי עזרה של ממשקי API ותנאים וכללים, תוכן דינמי שהקהילה תורמת, כמו בלוגים ופורומים, ותכונות של תמיכת לקוחות.
אתם יכולים ליצור אתר משלכם כדי לפרוס את המסמכים, או אם יש לכם חשבון Edge בתשלום, תוכלו להשתמש בפורטל של שירותי הפיתוח של Apigee. בפורטל יש תמיכה מובנית במסמכי תיעוד, בבלוגים, בפורומים ובסוגי תוכן אחרים שנדרשים כדי לתמוך בקהילת המפתחים שלכם.
SmartDocs מאפשר לכם לתעד את ממשקי ה-API בפורטל Developer Services באופן שמאפשר לכם ליצור מסמכי API אינטראקטיביים לחלוטין. מסמכי תיעוד אינטראקטיביים עם SmartDocs מאפשרים למשתמשים בפורטל:
- מידע על ה-API
- שליחת בקשה פעילה ל-API
- הצגת תגובה בזמן אמת שחוזרת מה-API
לדוגמה, באיור הבא מוצג ממשק API שמתוועד בפורטל באמצעות SmartDocs. ממשק ה-API הזה מספק מידע על מזג האוויר במיקום ספציפי:
המפתח מזין ערך לפרמטר השאילתה 'w' כדי לציין את המיקום, ואז לוחץ על הלחצן Send the request (שליחת הבקשה) כדי לראות את הבקשה והתגובה בזמן אמת. כשיוצרים מסמכי עזרה אינטראקטיביים לגבי ממשקי ה-API, משתמשי הפורטל יכולים ללמוד, לבדוק ולהעריך את ממשקי ה-API בקלות.
Edge Management API הוא API ל-REST שמאפשר לגשת לשירותי API באמצעות כל לקוח HTTP. ב-Apigee משתמשים ב-SmartDocs כדי ליצור מסמכי עזרה אינטראקטיביים ל-Edge Management API. כאן אפשר לקרוא את מסמכי העזרה של ה-API.
מידע נוסף זמין במאמר שימוש ב-SmartDocs לתיעוד ממשקי API.