טריגר של API

טריגרים של API משמשים להפעלה ישירה של שילובים.

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

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

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

הוספת טריגר של API

כדי להוסיף טריגר של API לאינטגרציה:

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

   כניסה ל-Application Integration

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

   מופיע הדף Integrations List, שבו מפורטים כל השילובים שזמינים בפרויקט ב-Google Cloud.

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

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

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

   האינטגרציה החדשה שנוצרה נפתחת בעורך האינטגרציות.

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

הגדרת טריגר של API

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

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

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

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

הערה: בדף הזה מוסבר איך להפעיל את הטריגר של ה-API באמצעות גרסה 1 של ה-API. יכול להיות שמפרט ה-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 '{"triggerId":"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: האזור של האינטגרציה, לדוגמה us-east1.

דוגמה

בדוגמה הבאה מופעלת אינטגרציה באזור 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 '{"triggerId":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-east1/integrations/-:execute"

לתשומת ליבכם

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

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

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

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

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