Apigee API hub
מחבר Apigee API hub מאפשר לכם לנהל, לגלות ולפקח על ממשקי API בפורטפוליו של הארגון.
גרסאות נתמכות
המחבר הזה תומך בגרסה v1 של Apigee API hub.
לפני שמתחילים
-
בפרויקט Google Cloud, מבצעים את המשימות הבאות:
- מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
- נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM roles/connectors.admin.
- מפעילים את השירותים הבאים:
-
secretmanager.googleapis.com(Secret Manager API) -
connectors.googleapis.com(Connectors API)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים. אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
-
- אם אתם משתמשים באימות של חשבון שירות במקום באימות OAuth 2.0, ודאו שניתנו לחשבון השירות ההרשאות המתאימות. מידע נוסף מופיע במאמר בנושא תפקידים מוגדרים מראש ב-IAM.
יצירת חיבור ל-Apigee API hub
החיבור ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים מיקום מהרשימה אזור ולוחצים על הבא.
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- בקטע פרטי החיבור, מבצעים את הפעולות הבאות:
- בוחרים באפשרות Apigee API hub מתוך רשימת המחברים.
- בוחרים גרסה של מחבר מהרשימה Connector version (גרסת המחבר).
- בשדה Connection Name, מזינים שם למופע החיבור. שם החיבור יכול להכיל אותיות קטנות, מספרים או מקפים. השם צריך להתחיל באות ולהסתיים באות או במספר, והוא לא יכול להכיל יותר מ-49 תווים.
- אפשר גם להזין תיאור למופע החיבור.
- אופציונלי: מפעילים את Cloud logging ובוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-
Error. - חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- (אופציונלי) מגדירים את ההגדרות של צומת החיבור.
- מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
- מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
- לוחצים על הבא.
צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר טרנזקציות לחיבור מסוים, צריך יותר צמתים, ולהפך: כדי לעבד פחות טרנזקציות, צריך פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
- בקטע יעדים, מזינים את הפרטים של המארח המרוחק (מערכת העורף) שאליו רוצים להתחבר.
- בשדה סוג היעד, בוחרים יעד.
- בשדה כתובת המארח, מציינים את שם המארח או את כתובת ה-IP של היעד.
אם רוצים להזין עוד יעדים, לוחצים על +הוספת יעד.
- לוחצים על הבא.
-
בקטע אימות, מזינים את פרטי האימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
החיבור ל-Apigee API Hub תומך בסוגי האימות הבאים:
- OAuth 2.0 – קוד הרשאה
- אימות באמצעות חשבון שירות
- לוחצים על הבא.
כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
- בודקים את פרטי החיבור והאימות ולוחצים על יצירה.
הגדרת אימות
מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.
- OAuth 2.0 – קוד הרשאה: בוחרים באפשרות הזו כדי לבצע אימות באמצעות תהליך כניסה מבוסס-אינטרנט של משתמש. מציינים את הפרטים הבאים:
- Client ID: מזהה הלקוח שנדרש כדי להתחבר לשירות Apigee API hub של ה-backend.
- היקפים: רשימה מופרדת בפסיקים של ההיקפים הרצויים. כדי לראות את כל היקפי ההרשאות הנתמכים של OAuth 2.0 בשירות Google שאתם צריכים, אפשר לעיין בקטע הרלוונטי בדף היקפי הרשאות של OAuth 2.0 ל-Google APIs.
- סוד לקוח: בוחרים באפשרות Secret Manager secret. כדי להגדיר את ההרשאה הזו, צריך ליצור את ה-Secret ב-Secret Manager.
- גרסת סוד: גרסת סוד ב-Secret Manager לסוד הלקוח.
-
אימות חשבון שירות: בוחרים באפשרות הזו כדי לבצע אימות באמצעות חשבון השירות שסיפקתם בשלבים הקודמים כשמגדירים את החיבור הזה. מוודאים שנתתם לחשבון השירות את תפקידי ה-IAM וההרשאות הרלוונטיים שנדרשים לאימות.
- היקפי הרשאה: בתפריט הנפתח, בוחרים את היקפי הרשאה הנדרשים של OAuth 2.0. מידע נוסף זמין במאמר בנושא היקפי גישה.
בסוג האימות Authorization code, אחרי שיוצרים את החיבור, צריך לאשר את החיבור.
אישור החיבור
אם משתמשים ב-OAuth 2.0 – קוד הרשאה כדי לאמת את החיבור, צריך לבצע את המשימות הבאות אחרי שיוצרים את החיבור.
- בדף החיבורים, מאתרים את החיבור החדש.
שימו לב שהסטטוס של המחבר החדש יהיה נדרשת הרשאה.
- לוחצים על דרושה הרשאה.
יוצג לוח עריכת הרשאה.
- מעתיקים את הערך של Redirect URI (ה-URI של ההפניה האוטומטית) לאפליקציה החיצונית.
- מאמתים את פרטי ההרשאה.
- לוחצים על Authorize.
אם ההרשאה מתבצעת בהצלחה, סטטוס החיבור יהיה פעיל בדף החיבורים.
אישור מחדש של קוד הרשאה
אם אתם משתמשים בסוג האימות Authorization code וביצעתם שינויים בהגדרות של Apigee API hub, תצטרכו לאשר מחדש את החיבור שלכם ל-Apigee API hub. כדי לחדש את הרשאת הגישה לחיבור:
- לוחצים על החיבור הרצוי בדף החיבורים.
ייפתח הדף עם פרטי החיבור.
- לוחצים על עריכה כדי לערוך את פרטי החיבור.
- בודקים את הפרטים של OAuth 2.0 – קוד הרשאה בקטע אימות.
אם צריך, מבצעים את השינויים הנדרשים.
- לוחצים על Save. הלחיצה תעביר אתכם לדף פרטי החיבור.
- בקטע אימות, לוחצים על עריכת הרשאה. מוצגת החלונית Authorize (אישור).
- לוחצים על Authorize.
אם ההרשאה מתבצעת בהצלחה, סטטוס החיבור יהיה פעיל בדף החיבורים.
מגבלות המערכת
מחבר Apigee API hub יכול לעבד עד 20 עסקאות בשנייה, לכל צומת, ומגביל את מספר העסקאות מעבר למגבלה הזו. כברירת מחדל, Integration Connectors מקצה 2 צמתים (לזמינות טובה יותר) לחיבור.
מידע על המגבלות שחלות על Integration Connectors זמין במאמר מגבלות.
שימוש בחיבור של Apigee API Hub בשילוב
אחרי שיוצרים את החיבור, הוא זמין ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.
פעולות
המחבר הזה מספק שכבת הפשטה לאובייקטים של שירות הקצה העורפי המקושר. אפשר לגשת לאובייקטים של הקצה העורפי רק באמצעות ההפשטה הזו. ההפשטה מוצגת לכם כפעולות. Action היא פונקציה מסוג First Class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה Actions תהיה ריקה.
בעיות מוכרות
יש מגבלות על ההגדרות של המחבר Apigee API hub. הגודל המקסימלי של משאבים שאפשר לחפש בהם הוא 2.5MB, והגודל המקסימלי של קובצי מפרט API הוא 10MB. מידע נוסף מופיע במאמר מגבלות ב-Apigee API hub.
קבלת עזרה מקהילת Google Cloud
אתם יכולים לפרסם את השאלות שלכם ולדון במחבר הזה בקהילת Google Cloud בפורומים של Cloud.