לידקליינט + API
ה-API של לידקליינט מיועד לצוותי פיתוח שרוצים שילוב עמוק ומותאם אישית עם מערכות קיימות — ERP, CRM ייחודי, אפליקציה פנימית, פלטפורמת BI ועוד. דרך ה-REST API ניתן לקרוא ולכתוב לידים, לגשת להיסטוריית שיחות, להפעיל חיוג, ולנהל את מבנה הנתונים של המערכת. זהו הכלי המתאים לעסקים בעלי יכולות טכניות שרוצים לשלב את לידקליינט בתשתית הדיגיטלית הכוללת שלהם, בלי תלות בכלי ביניים.
איך החיבור עובד
ה-API מבוסס REST ומשתמש ב-Authentication דרך API Key. כל בקשה כוללת Authorization Header עם המפתח שניתן מלוח הבקרה. התגובות הן JSON עם פגינציה סטנדרטית. הפעולות הנפוצות כוללות GET /leads (רשימת לידים), POST /leads (יצירת ליד חדש), GET /calls (היסטוריית שיחות), ו-POST /dial (הפעלת חיוג). מומלץ לפנות לתמיכת לידקליינט לתיעוד מלא ולמפתח API.
איך מחברים
- 1. קבלו API Key — היכנסו ללוח הבקרה של לידקליינט ובקשו API Key מהגדרות החשבון.
- 2. בדקו קריאה ראשונה — שלחו GET /leads עם ה-Authorization Header ווודאו שמקבלים תגובה תקינה.
- 3. בנו את האינטגרציה — ממשו POST /leads לכל מקור ליד חיצוני, ו-GET /calls לדוחות ב-BI.
מה אפשר לעשות
- שילוב לידקליינט עם ERP פנימי של העסק.
- בניית דשבורד BI מותאם עם נתוני שיחות ולידים.
- הפעלת חיוג אוטומטי מתוך מערכת פנימית.
- ייצוא היסטוריית לידים לניתוח מתקדם.
החיבור לעומק — איך לעבוד עם API
מיפוי שדות ב-REST API: בקשת GET /leads מחזירה מערך JSON עם שדות סטנדרטיים לכל ליד — id, name, phone, source, created_at, status, agent_id. לפגינציה נדרש שימוש בפרמטרי page ו-per_page. בקשת POST /leads מצפה ל-JSON עם לפחות name ו-phone; שדות נוספים כמו source ו-notes הם אופציונליים. מומלץ לאמת את המבנה מול תיעוד ה-API הרשמי של לידקליינט.
אוטומציות נפוצות דרך ה-API: שימוש ב-GET /calls עם פרמטר date_from מאפשר ייצוא שיחות לפי תאריך לדשבורד BI; POST /dial עם phone ו-agent_id מפעיל חיוג אוטומטי ממערכת פנימית; PATCH /leads/{id} מאפשר עדכון סטטוס ליד מה-CRM הפנימי חזרה ל-לידקליינט לסנכרון דו-כיווני. אלה דוגמאות — יש לאמת Endpoints ספציפיים מול תיעוד לידקליינט.
טיפול בשגיאות ב-API: ה-API מחזיר קודי HTTP סטנדרטיים — 200/201 להצלחה, 400 לשגיאת בקשה, 401 לאימות נכשל, 404 למשאב לא קיים, 429 לחריגת Rate Limit, 500 לשגיאת שרת. מומלץ לבנות Retry Logic לקודי 429 ו-5xx עם Exponential Backoff, ולרשום שגיאות 4xx ל-לוג לניתוח מאוחר. אל תנסו שוב אוטומטית על שגיאות 400 — הן מצביעות על בעיה בבקשה עצמה.
מבחינת אבטחה, ה-API Key חייב להיות מאוחסן במשתנה סביבה (Environment Variable) בלבד — לעולם לא ב-Frontend Code, ב-Git Repository, או ב-לוגים. מומלץ להשתמש ב-Secrets Manager (AWS Secrets Manager, HashiCorp Vault) בסביבת ייצור. אם ה-API Key נחשף — צרו מפתח חדש מיידית ובטלו את הישן.
השוואה בין Webhook ל-REST API Polling: Webhook הוא Push — לידקליינט שולחת נתונים אליכם בזמן אמת; API Polling הוא Pull — אתם מסקרים את ה-API כל X שניות לבדוק אם יש לידים חדשים. Webhook עדיף ברוב המקרים — מהיר יותר, יעיל יותר, ומפחית עומס על ה-API. API Polling מתאים כאשר Webhook אינו זמין, לדוגמה לייצוא נתונים אצווה (Batch) לדשבורד.
לבדיקת ה-API: השתמשו ב-Postman או ב-curl לשליחת בקשות ידניות לפני שכותבים קוד. תחילה שלחו GET /leads עם ה-API Key ובדקו שמקבלים תגובה תקינה. לאחר מכן שלחו POST /leads עם JSON של ליד בדיקה ובדקו שמוחזר קוד 201 ושה-id של הליד החדש כלול בתגובה. בדיקות ידניות מגלות בעיות מיפוי לפני כתיבת קוד.
תרחיש לדוגמה: חברת SaaS בנתה Integration Dashboard פנימי. כל בוקר ב-08:00, cron job ישראלי מריץ GET /leads עם date_from=yesterday ומייצא את כל הלידים של אתמול ל-Google BigQuery. Looker Studio מציג גרף לפי מקור ליד ולפי נציג. ב-14:00 cron שני מריץ POST /dial על כל לידים עם status=new שטרם טופלו — מפעיל חיוג אוטומטי לנציגים.
Rate Limit וניהול מכסות: כאשר ה-API מחזיר 429, ה-Header X-RateLimit-Remaining מציין כמה בקשות נשארו ב-Window הנוכחי, ו-X-RateLimit-Reset מציין מתי ה-Window מתחדש. מומלץ לנטר ערכים אלה ולהאט את קצב הבקשות לפני שמגיעים למגבלה — כך מונעים חסימה ומבטיחים שה-Integration פועל ברציפות. פרטים על מגבלות ספציפיות — דרך תמיכת לידקליינט.
Webhook רישום דרך ה-API: ה-API מאפשר לרשום Webhook Endpoints באמצעות POST /webhooks — כלומר ניתן לנהל Webhooks תכנותית מבלי להיכנס לממשק. זה שימושי בסביבות Multi-Tenant שבהן כל לקוח צריך Webhook ייחודי; הקוד מרשם את ה-Endpoint דינמית עם Token ייחודי ומוחק אותו כאשר הלקוח מסיים. בדקו עם תמיכת לידקליינט אם Endpoint זה זמין.
שאלות נפוצות — API
האם ה-API מתועד?
כן, תיעוד ה-API זמין ללקוחות לידקליינט עם חשבון פעיל. פנו לתמיכה לקבלת תיעוד מלא ועדכני.
מהי מגבלת הקצב (Rate Limit) של ה-API?
מגבלת הקצב תלויה בתוכנית — מומלץ לפנות ל-לידקליינט לפרטים על המגבלות הספציפיות לחשבון שלכם.
האם ה-API תומך ב-Webhooks מובנים?
כן, דרך ה-API ניתן גם לרשום Webhook Endpoint שיקבל פוש אוטומטי בכל אירוע, במקום לסקור (poll) את ה-API.
האם יש SDK?
כיום אין SDK רשמי — ה-API הוא REST סטנדרטי שניתן לשלב מכל שפת תכנות. מומלץ לבדוק עם תמיכת לידקליינט אם יש ספריות קהילתיות.
אינטגרציות נוספות
לידקליינט מתחברת לעוד כלים, מערכות CRM, פלטפורמות פרסום ובוני אתרים. הנה כמה חיבורים נוספים שאולי תרצו.