טריגר אוטומציה דרך Webhook
ממשק זה מאפשר לכל מערכת חיצונית, אתר, חנות, מערכת CRM או כלי אוטומציה, להפעיל אוטומציה שבניתם במיקרופיי, באמצעות בקשת HTTP אחת. השדות שאתם שולחים הופכים למשתנים בתוך האוטומציה, והיא מבצעת את כל השאר: שולחת סמס, וואטסאפ, הודעה קולית ומייל, רושמת שורה בגוגל שיטס, בודקת תנאים ומריצה תהליך שלם. חיבור אחד, בלי קוד.
מה זה טריגר אוטומציה?
בעוד שממשק שליחת הסמס שולח הודעה בודדת, טריגר האוטומציה מפעיל תהליך שלם שהגדרתם מראש בבונה האוטומציות של מיקרופיי. אתם מצביעים על כתובת אחת ושולחים אילו נתונים שתרצו, כמו שם, טלפון ומספר הזמנה, והאוטומציה קובעת מה קורה עם הנתונים האלה: לאיזה ערוץ לשלוח, מתי, ובאילו תנאים. זה מה שהופך את מיקרופיי למנוע אוטומציה שיושב בין המערכות שלכם, ולא רק לממשק שליחה.
תהליך השימוש
הכנה חד-פעמית במערכת, ואז אפשר להפעיל את האוטומציה מכל מערכת:
1 יוצרים טוקן עם הרשאת אוטומציה (ניתן להגביל אותו לרשימת כתובות IP).
2 בונים אוטומציה עם טריגר Webhook נכנס, ומצהירים על שמות השדות שהמערכת החיצונית תשלח.
3 מפעילים את האוטומציה (אוטומציה בטיוטה או מושהית לא תגיב).
4 מזינים במערכת החיצונית את הכתובת, ה-token ואת מזהה האוטומציה autoid.
כתובת הממשק ושיטת השליחה
הכתובת לפנייה לממשק היא:
https://www.micropay.co.il/extApi/autoWebhook.php
אפשר לשלוח את הנתונים בשלוש דרכים, והמערכת מזהה אוטומטית לפי אופן הבקשה. אין צורך בפרמטר שיטה:
- GET: כל הפרמטרים בכתובת ה-URL.
- POST: הפרמטרים בגוף הבקשה הרגיל (
application/x-www-form-urlencoded). - JSON: עם הכותרת
Content-Type: application/json, וכל הנתונים, כוללtokenו-autoid, נשלחים בתוך גוף ה-JSON.
אימות וטוקן
כל קריאה דורשת פרמטר token, טוקן שיצרת במערכת עם הרשאת אוטומציה.
פרמטרים
| פרמטר | חובה | תיאור |
|---|---|---|
token | חובה | טוקן הזדהות שיצרת במערכת, עם הרשאת אוטומציה. |
autoid | חובה | מזהה האוטומציה שברצונך להפעיל (מספר), כפי שמופיע ברשימת האוטומציות. האוטומציה חייבת להיות מסוג טריגר Webhook נכנס ובמצב פעיל. |
| השדות שלך | רשות | כל שדה נוסף שתשלח (למשל fullName, phone, orderId) יהפוך למשתנה זמין בשלבי האוטומציה בפורמט {{trigger.fieldName}}. רק שדות שהוגדרו בטריגר של האוטומציה נשמרים, השאר נזרקים. כל ערך מוגבל ל-500 תווים, ושדה ששמו מכיל phone מנורמל אוטומטית (מספר ישראלי בכל פורמט מקומי; מספר מחו״ל עם קידומת המדינה). |
דוגמאות קוד
הדוגמאות מוצגות ב-cURL. שים לב שבשליחת JSON גם ה-token וה-autoid נמצאים בתוך גוף הבקשה.
curl "https://www.micropay.co.il/extApi/autoWebhook.php?token=XXXXX&autoid=42&fullName=%D7%93%D7%A0%D7%94&phone=0501234567"curl -X POST https://www.micropay.co.il/extApi/autoWebhook.php \ --data-urlencode "token=XXXXX" \ --data-urlencode "autoid=42" \ --data-urlencode "fullName=דנה" \ --data-urlencode "phone=0501234567"
curl -X POST https://www.micropay.co.il/extApi/autoWebhook.php \ -H "Content-Type: application/json" \ -d '{ "token": "XXXXX", "autoid": 42, "fullName": "דנה", "phone": "0501234567", "orderId": 1001 }'
תשובת השרת
פורמט התשובה נקבע לפי אופן הפנייה: בשליחת GET/POST מוחזר טקסט פשוט, ובשליחת JSON מוחזר מבנה
{status, message, data} אחיד, כמו בשאר הממשקים (status הוא 1 בהצלחה ו-0 בשגיאה, ו-data כולל תמיד את remoteIP).
# הצלחה: OK ואחריו קוד הריצה (runId) OK 78412 # שגיאה: ERROR ואחריו תיאור ERROR --> Description: Automation not found
// הצלחה {"status":1,"message":"OK","data":{"taskId":"78412","remoteIP":"203.0.113.10"}} // שגיאה {"status":0,"message":"ERROR","data":{"description":"Automation not found","remoteIP":"203.0.113.10"}}
שגיאות נפוצות
| הודעה | משמעות |
|---|---|
| Missing token parameter | לא נשלח פרמטר token. |
| Invalid token | הטוקן שגוי או לא קיים. |
| Automation permission denied | לטוקן אין הרשאת אוטומציה. |
| IP not allowed | כתובת ה-IP של השולח אינה ברשימת ההיתר של הטוקן. |
| Missing or invalid autoId parameter | לא נשלח autoid תקין (מספר). |
| Automation not found | ה-autoid לא נמצא, או שהאוטומציה אינה פעילה או אינה שייכת לטוקן. |
| Rate limit exceeded | חריגה ממגבלת הקצב שהוגדרה לאוטומציה. |
אבטחה
- שמרו על סודיות הטוקן: הממשק מיועד לקריאות שרת-לשרת. אין להטמיע את הטוקן בטופס HTML או בקוד בצד הלקוח, שם הוא חשוף לכל מבקר. שליחת טופס מאתר תתבצע דרך השרת שלכם (או תוסף הטפסים), שיקרא לממשק וישמור את הטוקן בסוד.
- הטוקן חייב הרשאת אוטומציה, אחרת הבקשה נדחית.
- ניתן להגביל את הטוקן לרשימת כתובות IP מותרות.
- ניתן להגדיר הגבלת קצב (rate limit) לכל אוטומציה, לפי דקה, שעה או יום.
שאלות נפוצות
מה ההבדל בין טריגר אוטומציה לבין שליחת סמס רגילה ב-API?
קריאה לממשק שליחת הסמס שולחת סמס אחד. טריגר אוטומציה מפעיל תהליך שלם שבניתם: הוא יכול לשלוח סמס, וואטסאפ, הודעה קולית ומייל, לרשום שורה בגוגל שיטס, לבדוק תנאים ולהמתין, הכל מאותה בקשה אחת.
באיזה פורמט צריך לשלוח את מספר הטלפון?
מספרים ישראליים אפשר לשלוח בכל פורמט מקומי, עם או בלי אפס בהתחלה. מספרים מחו״ל יש לשלוח עם קידומת המדינה (למשל 44 לבריטניה). הנרמול חל אוטומטית על שדות ששמם מכיל phone, ומספר שלא זוהה נשמר כפי שנשלח.
מאיפה משיגים את מזהה האוטומציה (autoid)?
המזהה מופיע ברשימת האוטומציות במערכת. בונים אוטומציה עם טריגר Webhook נכנס, מצהירים על שמות השדות שיישלחו, ומפעילים אותה. את המזהה והטוקן מזינים בבקשה.
אילו שדות נכנסים לאוטומציה?
רק שדות שהוגדרו בטריגר של האוטומציה. כל שדה מוגדר זמין בשלבים כמשתנה בפורמט {{trigger.fieldName}}. שדות שלא הוגדרו נזרקים, וכל ערך מוגבל ל-500 תווים.