ה-API
אין נקודת קצה פרטית. אפילו לא עבור הממשק עצמו.
לרוב המוצרים יש שני APIs: המתועד שמוצע לך, והמעניין שבו משתמשים המסכים שלהם עצמם. השני תמיד טוב יותר, ולעולם לא מרשים לך להתקרב אליו. כאן יש אחד, והממשק הוא לקוח שלו כמו כל דבר אחר — זו אילוץ עבורנו, וזו הסיבה שכל מה שאתה רוצה לבנות הוא אפשרי.
מה הכלל הזה באמת עולה
המשמעות היא שמסך לפעמים צריך לחכות שה-API יהיה נכון, במקום לעקוף אותו כדי לקבל שדה נוח אחד. היום שבו מסך צריך משהו שה-API הציבורי לא יכול לתת לו הוא היום שבו ה-API שגוי, והתיקון הוא ב-API.
התמורה היא ששלושה לקוחות שונים מאוד עולים כמעט בשום תוספת. שרת ה-MCP הוא לקוח. אריח ב-dash-b הוא לקוח. הסקריפט שלך הוא לקוח. אף אחד מהם אינו אזרח סוג ב' שמתחבא למשטח שתוכנן למישהו אחר, כי אין משטח אחר שאפשר להיות שני לו.
מתועד, ומתורגל
OpenAPI נוצר ב-/docs ולכל מסלול יש בדיקה שהיא הדוגמה בתיעוד. תיעוד שנכתב בנפרד מהקוד סוטה תוך חודש; תיעוד שמפיל את הבנייה כשהוא שגוי — לא.
התחברות
חשבון ה-castomo שלך, דרך זרימת authorization code עם PKCE — אותו חשבון שבו אתה משתמש ב-dash-b ובשאר המשפחה. דף ללא שרת משלו מריץ את הזרימה הזו בצורה מושלמת; זו בדיוק המטרה שלשמה היא תוכננה. לעבודה מכונה-למכונה — מפתח API בהיקף פרויקט.
- 1אנשים
/v1/contacts·/lists·/segments·/tags·/imports - 2תוכן
/v1/creatives, עם ולידציה, תצוגה מקדימה ורינדור לכל יעד - 3אוטומציה
/v1/funnels·/funnels/:id/versions·/runs·/simulate - 4שידור
/v1/campaigns, עם קהל, מימוש, תזמון ושליחה כשלבים נפרדים - 5אירועים נכנסים
/v1/events— האירועים של היישום שלך עצמו, כטריגרים - 6מסירה
/sender-identities·/domains·/apps·/webhooks - 7מספרים
/v1/reports/*, ו-/track/*במארח המעקב
OpenAPI ב-/docs/mcp באותו תהליך
מוסכמות
אותה צורה כמו כל שירות castomo אחר
וזה חשוב יותר ממה שזה נשמע. אם אתה כבר קורא לאחד מאלה, אתה כבר יודע איך השירות הזה עונה, נכשל ומדפדף.
מעטפת שגיאה אחת
לכל כישלון אותה צורה, קוד יציב והודעה שמיועדת לבן אדם. אף מסלול לא ממציא לעצמו דרך משלו להיות לא מרוצה.
עימוד בסמנים (cursor)
לא היסטים (offsets). רשימה שמשתנה בזמן שאתה עובר עליה לא מדלגת או חוזרת על שורות בשקט — מה שעימוד בהיסטים עושה בשקט ובאופן קבוע.
מפתחות אידמפוטנטיות
בכל נתיב שמשנה נתונים. נסה שוב בקשה שאינך בטוח שנקלטה ותקבל את אותה תשובה — ולא איש קשר שני, קמפיין שני או שליחה שנייה.
מוגבל לפרויקט
טוקן מכוון לדייר אחד ולפרויקט אחד, שניהם יחד. אבטחה ברמת שורה נאכפת במסד הנתונים עצמו, ולא בזכות זכירה להוסיף תנאי.
Webhooks יוצאים
חתומים, נשלחים שוב עם השהיה הדרגתית, ומועברים לפחות פעם אחת — לכן גם נקודת הקצה שלך צריכה להיות אידמפוטנטית. האירועים משתמשים באותו אוצר מילים שהדוחות משתמשים בו.
מחיקה וייצוא
ניתן לייצא או למחוק איש קשר דרך ה-API, ומחיקה מגיעה לכל שירות אח שמחזיק עותק — דרך הערוץ הפנימי של המשפחה עצמה.
כל מה שהממשק יכול לעשות, POST יכול לעשות.
האירועים הם החלק המעניין
כל השאר בעמוד הזה הוא תשתית שאתה מצפה לה. POST /v1/events הוא הנתיב שמשנה את מה שהמוצר מיועד לו.
האפליקציה שלך כבר יודעת דברים שאף כלי שיווקי לא יכול לראות: מי סיים תהליך הכוונון, מי הזמין עמית, מי נתקל במגבלה, מי ייצא את הנתונים שלו ביום ראשון אחר הצהריים. שלח אותם כאירועים עם הטוקן שלך, וכל אחד מהם הופך לטריגר, לתנאי ולסגמנט.
השאר נובע ממודל איש הקשר. אירועים מתווספים בלבד, לעולם לא נערכים; הם היומן שכל המוצר נתלה עליו. משפך שמופעל על ידי אירוע שהגדרת אינו אינטגרציה — זו אותה מכניקה שבה message_opened משתמש, רק עם שם אחר בתוכה.
- 1אתה שולח אותו
POST /v1/events— שם, איש קשר, מטען נתונים ומפתח אידמפוטנטיות. - 2הוא נקלטמתווסף ליומן של איש הקשר. אף דבר אחר לא צריך לדעת שהוא קיים.
- 3משפך מתחילכל משפך שהכניסה שלו מזכירה את האירוע הזה, עבור כל איש קשר שעומד בקריטריוני הכניסה שלו.
- 4משפכים אחרים מסתעפים עליו"האם האירוע הזה קרה ב-14 הימים האחרונים" הוא תנאי סגמנט רגיל.
- iוהוא מסיים ריצותצומת יעד שמזכיר את אותו אירוע עוצר רצף ברגע שהאדם עושה את הפעולה.
אוצר המילים שלךהטוקן שלך
גבולות שכדאי להכיר לפני שאתה בונה
ClickSomo מאחסן שלושה מזהים עליך — דייר, פרויקט ומשתמש, כמזהים אטומים — וכלום מעבר לכך. לא סיסמה, לא פרופיל, לא כרטיס, לא חשבונית. מגבלות התוכנית מגיעות כמספרים: כמה אנשי קשר, כמה שליחות, כמה יצירות. אוצר המילים של התשלומים לא חוצה את הקו הזה לאף כיוון.
אנשי הקשר שלך שייכים לך. אתה בקר הנתונים; אנחנו מעבד הנתונים. אין נתיב שבו מוצר אחר במשפחה יכול לקרוא או לכתוב לרשימת אנשי הקשר שלך, ואין ערוץ קליטה שאחד כזה יכול להשתמש בו.
אם אתה שוקל את זה ברצינות: קרא את /docs לפני שתמשיך לקרוא עוד מהאתר הזה. ה-API הוא התיאור הכנה של מה שהמוצר עושה, וכל טענה בעמודים האלה ממופה לנתיב או לסוג צומת שתמצא שם. כשהסכמה משתנה, העמודים האלה משתנים.