טריגר API

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

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

• מגדירים את מטען הייעודי (payload) של הבקשה והתגובה באמצעות משתני קלט ופלט ספציפיים לטריגר.
• יצירה והצגה של מפרט OpenAPI (OAS) לשילוב.
• הפעלת שילוב סינכרוני או אסינכרוני.

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

הוספת טריגר API

כדי להוסיף API trigger לשילוב, מבצעים את השלבים הבאים:

1. נכנסים לדף Application Integration במסוף Google Cloud .

   מעבר אל Application Integration

2. בתפריט הניווט, לוחצים על Integrations (שילובים).

   מוצגת רשימה של כל השילובים שזמינים בפרויקט Google Cloud בדף Integrations List.

3. בוחרים שילוב קיים או לוחצים על יצירת שילוב כדי ליצור שילוב חדש.

   אם יוצרים שילוב חדש:

   1. מזינים שם ותיאור בחלונית יצירת שילוב.
   2. בוחרים אזור לשילוב.
      הערה: בתפריט הנפתח Regions (אזורים) מופיעים רק האזורים שהוקצו בפרויקט בענן שלכם ב-Google Cloud. כדי להקצות אזור חדש, לוחצים על הפעלת אזור. מידע נוסף מופיע במאמר בנושא הפעלת אזור חדש.
   3. בוחרים חשבון שירות לאינטגרציה. אפשר לשנות או לעדכן את פרטי חשבון השירות של שילוב בכל שלב מחלונית סיכום השילוב בסרגל הכלים של השילוב.
      הערה: האפשרות לבחור חשבון שירות מוצגת רק אם הפעלתם את האפשרות 'שליטה בשילובים' באזור שנבחר.
   4. לוחצים על יצירה.

   השילוב החדש שנוצר ייפתח בכלי השילובים.

4. בסרגל הניווט של כלי העריכה של השילוב, לוחצים על טריגרים כדי לראות את רשימת הטריגרים הזמינים.
5. לוחצים על הרכיב API trigger (טריגר API) וממקמים אותו באזור העיצוב.

הגדרת טריגר API

כדי להגדיר טריגר API, לוחצים על הרכיב API trigger (טריגר API) בכלי לעריכת שילובים. מוצגת חלונית ההגדרה של טריגר ה-API עם השדות הבאים:

• תווית: השם הגלוי של טריגר ה-API בשילוב. אפשר לשנות את התווית לשם שרוצים.
• הערות: אפשר להוסיף הערות להפעלת ה-API כדי לספק מידע נוסף על ההפעלה.
• מזהה טריגר: מזהה ייחודי שמוקצה לטריגר של ה-API בפורמט api_trigger/TRIGGER_NAME.
  הערה: אפשר להשתמש ביותר מטריגר API אחד בשילוב. לכל טריגר של API מוקצה מזהה טריגר ייחודי.
• משתני קלט: משתני קלט ספציפיים לטריגר שאפשר להשתמש בהם כדי להגדיר את מטען הבקשה (payload) של טריגר ה-API.
  • כדי להוסיף או להסיר משתני שילוב קיימים מהטריגר של ה-API, לוחצים על שינוי ובוחרים את המשתנים הנדרשים בחלונית משתני קלט של טריגר ה-API.
  • כדי להוסיף משתנה חדש במיוחד לטריגר ה-API שנבחר, לוחצים על שינוי ובוחרים באפשרות + הוספת משתנה חדש בחלונית משתני קלט של טריגר ה-API. מידע על סוגי הנתונים הנתמכים מופיע במאמר סוגי נתונים נתמכים של משתנים.
• משתני פלט: משתני פלט ספציפיים לטריגר שאפשר להשתמש בהם כדי להגדיר את מטען התגובה של טריגר ה-API.
  • כדי להוסיף או להסיר משתני שילוב קיימים לטריגר ה-API, לוחצים על שינוי ובוחרים את המשתנים הנדרשים בחלונית משתני הפלט של טריגר ה-API.
  • כדי להוסיף משתנה חדש, במיוחד לטריגר ה-API שנבחר, לוחצים על שינוי ובוחרים באפשרות + הוספת משתנה חדש בחלונית משתני הפלט של טריגר ה-API. מידע על סוגי הנתונים הנתמכים מופיע במאמר סוגי נתונים נתמכים של משתנים.
הערה: אפשר ליצור משתני קלט ופלט גם מחלונית המשתנים וגם מחלונית ההגדרה של טריגר ה-API.
• Application Integration מוסיפה באופן אוטומטי משתנים שנוצרו מחלונית ההגדרה של טריגר ה-API לטריגר הספציפי הזה כמשתני קלט או פלט.
• אפשר להוסיף משתנים באופן ידני מטריגר API אחד לטריגר אחר כמשתני קלט או פלט.
• כברירת מחדל, לכל הרכיבים בשילוב יש גישה למשתנים שנוצרו בחלונית Variables (משתנים).
• שינוי סוג המשתנה של משתנה משפיע על כל האלמנטים בשילוב שמשתמשים במשתנה הזה.

הצגת מפרט OpenAPI לטריגר של ה-API

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

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

הפעלת טריגר API באמצעות קריאה ל-API

אחרי שמפרסמים שילוב עם טריגר API מוגדר, אפשר להשתמש ב-method‏ projects.locations.integrations.execute כדי להפעיל את הטריגר הזה מכל אפליקציה. השיטה הזו מפעילה את הביצוע במצב סינכרוני.

תחביר

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

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

• ‫TIMEOUT_SECONDS: הזמן הקצוב לתפוגה בשניות של הקריאה ל-API. ברירת המחדל של הזמן הקצוב לתפוגה היא 120 שניות. רשימה של פרמטרים מוגדרים מראש של בקשות מופיעה במאמר בנושא פרמטרים של המערכת.
• ‫TRIGGER_NAME: השם של הטריגר של ה-API בשילוב.
• ‫PROJECT_ID: מזהה הפרויקט ב- Google Cloud .
• ‫LOCATION: המיקום של הפרויקט ב- Google Cloud .

דוגמה

בדוגמה הבאה מופעל שילוב באזור us-east1 שמכיל את טריגר ה-API‏ test_API_1 בפרויקט demo-project ב-Google Cloud:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

לתשומת ליבכם

כשמשתמשים בהפעלה באמצעות API, הגודל המצטבר של כל משתני הקלט יכול להיות עד 8MB. אם הגודל חורג מ-8MB, Application Integration לא מפעיל את השילוב ותופיע שגיאה.

מכסות ומגבלות

מידע על מכסות ומגבלות זמין במאמר מכסות ומגבלות.

המאמרים הבאים

• מידע על כל המשימות והטריגרים
• איך בודקים ומפרסמים שילוב
• מידע נוסף על טיפול בשגיאות
• מידע נוסף על יומני ביצוע של שילובים