דיוור קל

API

לחבר טופס, חנות או כל מערכת אחרת — בלי לעבור דרך המסכים.

כניסה למערכת
כדי לנסות את הקריאות מכאן ולקבל מפתח — התחברו למערכת.
עובדים עם מודל AI? זו הדרך המומלצת להתחברמומלץ

הורידו את קובץ התיעוד, העלו אותו למודל ובקשו ממנו לכתוב את החיבור — הוא יקבל את כל הפעולות, השדות והשגיאות, ויכתוב קוד שעובד מהפעם הראשונה במקום לנחש.

לפני שמתחילים

כתובת הבסיס

https://mail.shimisystems.com

אימות

כל קריאה תחת /api/v1/ דורשת מפתח, באחת משתי כותרות — לבחירתכם:

Authorization: Bearer shk_xxxxxxxx
x-api-key: shk_xxxxxxxx
  • את המפתח יוצרים במערכת: הגדרות ← חיבורים ו-API. הוא מוצג פעם אחת בלבד ואי אפשר לראות אותו שוב — גם לא לנו.
  • עד 120 קריאות בדקה למפתח. בכל תשובה חוזרות הכותרות x-ratelimit-limit ו-x-ratelimit-remaining.
  • הפעלת אוטומציה היא היוצא מן הכלל: היא אינה דורשת מפתח, כי הכתובת עצמה היא הסוד.

שגיאות

כל שגיאה חוזרת באותו מבנה, כדי שאפשר יהיה לטפל בכולן במקום אחד:

{ "error": { "code": "unauthorized", "message": "…" } }
קודcodeמתי
401unauthorizedמפתח חסר, שגוי או שבוטל
404not_foundהמזהה אינו קיים, או אינו שייך לחשבון שלכם
422invalid_fieldsחסר שדה חובה או שערך אינו תקין — הפרטים ב-fields
429rate_limitedיותר מדי קריאות. חכו לפי retry-after

שליחת מייל

שליחה מיידית — מייל בודד או כמה מאות מיילים בקריאה אחת — בלי תלות בקמפיין או ברשימת תפוצה קיימת

2 פעולות

אנשי קשר

הוספה, עדכון, שליפה ומחיקה של אנשים ברשימות שלכם

5 פעולות

קבוצות

רשימות התפוצה — למי שולחים

2 פעולות

תגיות

מה נכון לגבי אדם — ומה יכול להפעיל אוטומציה

2 פעולות

הפעלת אוטומציה

להתחיל תרחיש מכל מערכת שיודעת לשלוח JSON

1 פעולות