fbpx

דוקומנטציות API

כל ההסברים לגבי דוקומנטציית API נמצאים בתוך המערכת

הגדרות ← API

בקרוב יהיה הסבר מורחב גם פה באתר

מה אפשר לעשות:

– הוספת ליד חדש
– הוספת משימה חדשה / תגובה בתוך ליד
– הוספת פגישה חדשה
– הוספת רכישה חדשה

-צפייה בלוגים של API במערכת

מה כרגע לא ניתן לעשות:

– לא ניתן לחפש בתוך ליד או מודול אחר
– לא ניתן לערוך נתונים
– לא ניתן למחוק
(יש כרגע רק אפשרויות הוספה)

דוקומנטציה להוספת ליד:

זה המבנה (להחליף את **** בסאבדומיין של המערכת שלכם)

Webhook URL עבור ליד חדש (POST – x-www-form)

https://****.taskey.co.il/webapi/AddLead.php

פרמטר (key)שם השדהפרמטרים נוספים שייקלטו
פרטי הליד
nameשם הלידשם,שם מלא,שם_מלא
phoneטלפוןטלפון
emailאימיילמייל,mail
שדות מיוחדים
commentתגובה חדשהcomment1,comment2
statusסטטוסברירת מחדל ליד חדש
user_idנציג משוייךברירת מחדל ללא שיוך
מקורות
sourceמקור הגעהform_name,utm_source
campaignקמפייןutm_campaign
adsetקהלutm_medium,audience
adמודעהutm_ad
channelערוץ התקשרותלדוגמא: וואטסאפ, שיחה נכנסת, שם דף נחיתה
שדות נוספים
cityעירעיר
addressרחוברחוב,כתובת
descriptionהערותהערות
שדות מותאמים אישית
Custom1שדה מותאם אישית 1 מוצג בתוך המערכת
Custom2-20יש עד 20 שדות מותאמים אישת

בMAKE.com יש לנו אפליקציה לזה, ורק לפרמטרים שלא קיימים באפליקציה ישירות אפשר להשתמש בAPI הפתוח בעזרת מודול HTTP MAKE A REQUEST

או בזאפייר בWEBHOOK
לפי המדריך של זאפייר
https://taskey.co.il/איך-מחברים-ליד-חדש-בזאפייר/


  • דוקומנטציה קליטת רכישה חדשה:

המבנה (להחליף את example בסאבדומיין של המערכת שלכם)

Webhook URL עבור רכישה חדשה (POST)
https://example.taskey.co.il/webapi/purchases/create/index.php
פרמטרשם שדה
פרטי המכירה
productnameשם המוצר
amountסכום
פרטי הליד
nameשם הליד
phoneטלפון
mailמייל

  • דוקומנטציה הוספת תגובה / משימה ללקוח קיים:

Webhook URL עבור רכישה חדשה (POST)
https://example.taskey.co.il/webapi/AddTask.php
פרמטרשם שדה
פרטי המשימה / תגובה
titleכותרת המשימה (חובה ליצירת משימה)
bodyתיאור המשימה
user_idלמי המשימה משוייכת (מספר משתמש)
user_id_followerמי עוקב אחרי המשימה (מספר משתמש)
פרטי המשימה / תגובה
commentטקסט התגובה
פרטי הליד (לשיוך משימה/תגובה לליד קיים)
phoneטלפון
mailמייל
 

  • דוקומנטציה הוספת פגישה ללקוח קיים:

Webhook URL עבור רכישה חדשה (POST)
https://example.taskey.co.il/webapi/AddMeeting.php
פרמטרשם שדה
פרטי הפגשיה / תגובה
titleכותרת הפגישה (חובה ליצירת הפגישה)
bodyתיאור הפגישה
start_dateתאריך ושעת התחלה (d-m-Y H:i)
end_dateתאריך ושעת סיום (d-m-Y H:i)
user_idלמי הפגישה משוייכת (מספר משתמש)
user_id_followerמי עוקב אחרי המשימה (מספר משתמש)
פרטי המשימה / תגובה
commentטקסט התגובה
פרטי הליד (לשיוך פגישה לליד קיים)
follow_idמזהה ליד
phoneטלפון
emailמייל

  • דוקומנטציה הוספת ריטיינר ללקוח קיים:

Webhook URL עבור רכישה חדשה (POST)
https://example.taskey.co.il/webapi/AddRecurring.php
פרמטרשם שדה
פרטי המשימה / תגובה
follow_idמזהה ליד (חובה)
produc_tnameשם המוצר (חובה)
sumסכום הריטיינר (חובה)
is_vatמע”מ (1 = כולל מע”מ, 0 = לפני מע”מ)

  • צפייה בלוגים של API במערכת:

 

לתמיכה בוואטסאפ:
0502249232

תפריט נגישות