סקירה כללית של ה-API של Pristo
ה-API של Pristo מאפשר למערכות שלכם לעבוד עם Pristo CX בשתי דרכים: שליחת אירוע שמפעיל הפצה מבוססת אירועים עבור איש קשר, ויצירת קישור לסקר עבור שאלון. שתי הפעולות הן בקשות POST עם גוף JSON לכתובת הבסיס https://api.pristo.io.
כל בקשה ל-API של Pristo כוללת מפתח API בכותרת X-API-Key. יוצרים מפתחות במערכת Pristo CX, בלשונית ניהול > מפתחות API, וכל מפתח שייך לתוכנית אחת.
גישה ל-API כלולה בחבילה הסטנדרטית ובחבילת פרימיום. בחבילה החינמית המערכת לא מציגה את הדף מפתחות API ולא יוצרת מפתחות. אירועים מפעילים סקרים רק דרך הפצות מבוססות אירועים, והמערכת מציגה את הדף הפצות רק בחבילת פרימיום. ראו חבילות ומגבלות.
נקודות קצה
קישור לקטע: נקודות קצה| מתודה ונתיב | מה היא עושה | מדריך |
|---|---|---|
POST /v1/events/send |
רושמת אירוע עבור איש קשר באוכלוסייה של התוכנית שאליה שייך מפתח ה-API. אחר כך הפצות פעילות מבוססות אירועים שבוחרות בסוג האירוע הזה שולחות את השאלון שלהן. | שליחת אירוע |
POST /v1/links/generate/{prjId} |
יוצרת קישור חד פעמי או רב פעמי לשאלון ומחזירה את כתובת ה-URL שלו ב-https://go.pristo.io. |
יצירת קישור לסקר |
הסכמות המלאות של הבקשות והתשובות נמצאות בתיעוד ה-API (באנגלית). התיעוד זמין באנגלית בלבד.
איך זה עובד
קישור לקטע: איך זה עובדאירועים. המערכת שלכם מדווחת על משהו שקרה ללקוח, למשל רכישה. האירוע נשמר מיד ב-Pristo CX, שמחזירה את ה-eventId שלו. זמן קצר אחר כך, Pristo CX מוסיפה את איש הקשר לאוכלוסיית התוכנית או מעדכנת אותו, ובודקת את ההפצות הפעילות מבוססות האירועים. כל הפצה שבוחרת בסוג האירוע הזה, ושהאירוע ואיש הקשר תואמים למסננים שלה, מתזמנת את השאלון לשליחה ב-SMS או באימייל.
אנשי קשר. אין ב-API נקודת קצה נפרדת לאנשי קשר. אנשי קשר נוצרים ומתעדכנים מתוך האובייקט contact שאתם שולחים עם כל אירוע.
קישורים לסקרים. מבקשים קישור לשאלון אחד, ושולחים את ה-url שמתקבל למשיב בערוץ שלכם, למשל בצ’אט, בקבלה או באפליקציה. קישור חד פעמי אוסף משוב אחד. קישור רב פעמי אוסף משוב חדש בכל פעם שמישהו פותח אותו.
מוסכמות
קישור לקטע: מוסכמות| נושא | כלל |
|---|---|
| כתובת הבסיס | https://api.pristo.io |
| אימות | X-API-Key: <your key> בכל בקשה. ראו אימות באמצעות מפתח API |
| גוף הבקשה | JSON, עם הכותרת Content-Type: application/json. עד 10,000 בייטים |
| הצלחה | 200 OK עם אובייקט JSON קטן |
| שגיאות | ברוב תשובות ה-400 וה-404 הגוף הוא טקסט פשוט, לא JSON. ראו שגיאות API |
| מזהים | מזהי שאלונים ומזהי אירועים הם מזהים מקוצרים בני 22 תווים. מזהי קישורים הם UUID רגילים |