שליחת מיילים דרך ה-API של Smoove

שליחת מיילים דרך ה-API של Smoove

שלב ראשון: יצירת מפתח API

כדי להתחיל לעבוד עם ה-API צריך ליצור API Key:

1. נכנסים למערכת
2. עומדים על האווטאר (למעלה)
3. נכנסים ל מפתחות API ופיקסלים
4. לוחצים על +
5. יוצרים מפתח חדש

חשוב:

• לתת למפתח הרשאה מלאה
• לתת לו הקשר 

למה ההקשר חשוב?

ההקשר עוזר להתמצאות:
כל פעולה שנעשתה דרך אותו מפתח (עדכון איש קשר, שליחת מייל, שליחת SMS וכו’) תופיע בציר ההתקשרות של איש הקשר עם ציון ההקשר.

שלב שני: פתיחת ממשק הניסוי (Swagger)

לאחר יצירת המפתח:

1. לוחצים שמירה
2. לוחצים על קישור לשידור - פותח את ה-Swagger של Smoove:
   ממשק שמציג את כל הפונקציות של ה-API ומאפשר להתנסות בהן עם דוגמאות.

 

שלב שלישי: הפונקציה הרלוונטית לשליחת מייל

ניגשים אל
Campaigns → Create an email campaign
שם מזינים את שדות הבקשה.

בצד ימין יש גם Body Samples שאפשר להקליק עליהם כדי להכניס דוגמה אוטומטית לבקשה.

---

 דוגמא ראשונה: שליחת מייל מתבנית (Template)

1. יצירת תבנית במערכת
כדי לשלוח מתבנית צריך קודם ליצור אותה במערכת:

1. נכנסים ליצירת מייל
2. בוחרים תבנית (מעוצבת או בסיסית)
3. מעצבים את המייל
4. לוחצים על 'שמירה כתבנית' (אייקון לב)
5. נותנים שם ושומרים

לאחר מכן התבנית מופיעה תחת:
יצירת מייל ← התבניות שלי

2. שימוש נכון בשם התבנית
בשדה templateName שמים את שם התבנית המדויק.

⚠️ חשוב מאוד:
להעתיק את השם בדיוק (Copy-Paste).
שגיאת כתיב אחת = הבקשה תיפול והמייל לא יישלח.

3. שליחה מיידית או יצירה בלבד
בבקשה אפשר לבחור אם:

• לשלוח עכשיו
• או רק ליצור מייל לשימוש עתידי

4. פרמטרים מרכזיים
Track Link - שדה שמחליט האם לבצע מעקב אחרי לחיצות על קישורים.
Custom Data (החלק הכי חשוב בתבנית) - מאפשר לשלב טקסטים דינאמיים בתוך התבנית.

המבנה הוא:

• key = שם המשתנה
• value = הטקסט שיוזרק לתוך התבנית

ניתן לשים כמה משתנים שרוצים.

5. איך שמים משתנים בתוך התבנית?
בתוך התבנית עצמה כותבים משתנים בפורמט:

%A%
%B%

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

• A = "מוצרים חדשים הגיעו"
• B = "כדאי לבדוק במבצעים"


6. Subject (נושא)
בנושא אפשר לשלב שדות אישיים (כמו שם פרטי) ואת הנושא עצמו.

7. Unsubscribe - none
ההמלצה היא להשתמש בקישור ההסרה המובנה של המערכת.
כל מי שלוחץ עליו נחסם אוטומטית (מועבר לרשימת החסומים).

8. נמענים (toMembers)
בפרמטר הזה בוחרים לאילו כתובות לשלוח.
אם יש כמה נמענים מפרידים בפסיק.

9. בדיקת הצלחה
לוחצים Try ב-Swagger.
אם התקבלה תשובה: 200 = הצלחה

10. שליחה מתוזמנת (אופציונלי)
אפשר להגדיר מייל שיישלח בעתיד:

• מסמנים schedule = true
• מגדירים תאריך ושעה לפי הפורמט שמופיע ב-Swagger

---

דוגמא שניה: שליחת מייל HTML (בלי תבנית)

1. מה משתנה בבקשה?
הבקשה דומה, אבל:

• לא משתמשים ב־templateName
• לא משתמשים ב־customData
• כן משתמשים ב־body

ובתוך body שמים את תוכן ה-HTML.

2. חשוב מאוד: תקינות HTML
בשליחת HTML חייבים להקפיד על:

• HTML תקין
• escaping נכון כדי שהבקשה לא תישבר
  (למשל תווים בעייתיים, פסיקים, גרשיים וכו’)

אם ה-HTML לא בנוי נכון - הבקשה תישבר והמייל לא יישלח.

3. ה-URL לשליחה
בתשובת ה-200 מתקבל גם:

• ה-URL המלא לשליחה
• כולל המקום שבו צריך לשלב את מפתח ה-API
  (ב-Query String או ב-Header)

4. פוטר מובנה במייל
בכל סוג מייל (תבנית או HTML) המערכת מוסיפה אוטומטית:

• קישור להסרה
• קישור לצפייה בגרסת Web