API זה זמין ללא תוספת עלות לכל חשבון המשתמש במערכת הפניות של הכוורת.
במידה ואתם מעוניינים להכניס פניות שירות מהאתר, מפייסבוק או מדפי נחיתה יעודיים, יש להשתמש ב-API פניות של הכוורת
שימו לב, שבשלב זה, ה-API יפעל רק לאחר בקשת גישה אליו דרך פניה למחלקת שירות הלקוחות שלנו, ולאחר אישור חשבונכם, תקבלו את הקישור לעבודה ב-API
יש לשלוח אל הקישור הבא ב-GET/POST את ה-raw JSON
https://api.kaveret.biz/ticketing/api/create-ticket/YOURACOUNTTOKEN
דוגמה ל-json שיש לשלוח:
| שם משתנה | תיאור | הערות |
| name* | שם הכרטיס | חובה |
| email* | כתובת המייל | חובה |
| mobile* | טלפון סלולרי | |
| businessId* | ח.פ./ת.ז. | |
| phone* | טלפון | |
| title | כותרת | |
| message | תוכן ההודעה | חובה |
| branchId | קוד סניף | חובה באם משתמשים במודול הסניפים |
| interactionTypeId | סוג אינטרקציה | מספר סוג האינטרקציה במערכת |
| source | מקור הגעה | |
| userAssignedId | משתמש להקצאה | באם ריק, יהיה ב"פניות שלא הוקצו" |
ticketType | מחלקה להקצאה | מספר המחלקה במערכת – באם ריק, ילך לדיפולטית |
| cardTypeId | סוג כרטיס להקמה | במידה ולא קיים כרטיס לפונה, איזה סוג כרטיס לפתוח (יש לשלוח מספר סוג כרטיס – לדוגמה לליד 5 |
| city | עיר | שם עיר מרשימת הערים |
השדות המסומנים בכוכבית הינם שדות זיהוי, כלומר אם השם או הסלולרי או קוד העסק זהים להגדרות זיהוי כרטיסים אצלכם במערכת, המערכת תשייך את הפניה לכרטיס קיים, בכל מקרה של סתירה או חוסר זיהוי של הכרטיס, יווצר כרטיס חדש (אותו ניתן אח"כ למזג לכרטיס קיים)
במידה והשליחה הצליחה תקבלו את ה-JSON הבא
{
"res": "Ok",
"code": 200
}
במידה ולא, תקבלו שגיאה עם תיאור השגיאה
{
"message": "An error occurred",
"errors": [
"Please check the type of your properties"
]
}
לפני תחילת עבודה, יש להגדיר כתובות IP אשר אתם מאשרים לשליחה API אל המערכת. לא ניתן לפתוח גישה ללא הגבלת כתובת IP.
דוגמה לשימוש של שדה דינמי:
בדוגמה זו, אני שולח לשדה דינמי מספר 76 את הערך "כספים", לסוג התקשרות מייל, ומשייך את הפניה למשתמש 800
{"name": "Ofir Bek","email":"offr@micro.soft", "mobile": "","message" : "שלום, ערים?", "interactionTypeId" : "2", "userAssignedId": 800 ,"extraData": { "cf": { "interaction": { "_cf_76": "כספים"} }}}





