חוקי API

מערכת ה CRM מאפשרת לקבל לקוחות למאגרים קיימים על-ידי API וכך לקבל את הלידים שמגיעים מפרסומים ישירות למאגר הלקוחות במערכת.

יצירה או עריכת חוקי API מתבצעת כברירת מחדל בתפריט הראשי: "פרויקטים" ← "ניהול" ← "חוקי API".

יצירת חוק API

כדי ליצור API חדש תחילה יש לבחור את הפרויקט ואת המאגר שמשויך לפרויקט שאליו נרצה לשייך את הלקוחות שיגיעו דרך ה API.

יצירת חוק API חדש

לאחר שנבחר מאגר ההערה שבכחול "עליך לבחור מאגר בכדי להתחיל לערוך חוקי API" תתחלף ל '+'.

כפתור יצירת חוק API חדש

כאשר נלחץ על ה'+' נעבור לתהליך יצירת חוק API חדש עם ארבעה שלבים:

1. בחירת שדות: בשלב זה נבחר את השדות אותם נרצה שה API ימלא במאגר כאשר הוא מקבל נתוני הלקוחות.
   

   בחירת שדות ביצירת חוק API חדש
2. הגדרות API:
   

   יצירת חוק API חדש - הגדרות API
   1. שיטת גישה לחוק API: נדרש לבחור את שיטת משלוח ה-API (יש להתאים את השיטה לצורת השליחה של מקור ה-API).
   2. הגבל את סך הבקשות בפרק זמן מסוים: מגביל את סך בקשות ה API שיכולות להתקבל בפרק זמן מוגדר (עוזר למניעת ספאם).
   3. הגבל את מספר הבקשות שנכשלו בפרק זמן מסוים: מגביל את מספר בקשות ה API שנכשלו בעת קבלתם (עוזר למניעת ספאם).
3. סוג חוק API:
   

   הגדרת סוג חוק API ביצירת חוק API API
   1. סטטוס לקוח: לקוחות שייכנסו דרך ה API הסטטוס יוגדר להם כפי הסטטוס שנבחר ב "סטטוס לקוח". (שדה זה אינו שדה חובה).
   2. הגדרות API:
      1. לקוח ממקור אורגני: לקוחות ממקור אורגני מקבלים עדיפות על לקוחות ממקור שאינו אורגני ולכן אם קיים לקוח ממקור לא אורגני ואותו לקוח התווסף ממקור אורגני הפרטים של הלקוח התעדכנו לפי המקור האורגני.
      2. אם הלקוח כבר קיים במערכת: לקוח ייחשב כפול אם לא עבר פרק הזמן שהוגדר בשדה זה.

1. בחירת מגבלות IP: ההתחברות ה API מתבצעות לפי כתובות IP, יש לבדוק את הגבלות ה IP של הממשק אליו אתם מתחברים. לדוגמא, integromat (make) מצריך אישור כתובת IP לפי המסמך באתר שלהם.
   

   יצירת סוג API חדש - בחירת מגבלות IP

בסיום התהליך יש ללחוץ על "אישור" וייווצר חוק API חדש. המשויך למאגר שהגדרנו.

עריכת חוק API קיים

קיימת אפשרות לערוך חוק API קיים על-ידי לחיצה ימנית בעכבר על חוק ה API אותו נרצה לשנות.

עריכת חוק API קיים

לאחר הלחיצה יפתחו מספר אפשרויות:

• הצגת קישור: מציג את הקישור של ה API. בעזרת הקישור מתחברים ל integromat, zapier וכו'.
  

  הצגת קישור API
• עריכת חוק: מאפשר לערוך את כל השלבים שעברנו עליהם בעת יצירת חוק ה API.
  

  עריכת חוק API
• שכפול חוק: מאפשר לשכפל חוק API במידה ונרצה ליצור חוק API עם הגדרות זהות לחוק API חדש.
  

  שיכפול חוק API קיים
• יצירת מפתח חדש: בחירה באפשרות זו תשנה את המפתח של חוק ה API.
• היסטוריית בקשות: מאפשר לצפות בכל בקשות ה API שהתקבלו.
• מחיקת חוק: מוחק את חוק ה API.

קישור ה API

לנוחיותכם, מובאים כאן הגדרות התממשקות ל-API של Make ושל Zapier.

• להגדרות של Make (לשעבר Integromat)
• להגדרות שימוש ב-Make App
• להגדרות של Zapier

סוגי תשובות ה-API

מצ"ב קודי תשובות מה-API וההסברים. התשובה המחוזרת היא בפורמט JSON הבא:

{
    "result": <true/false>,
    "data": [
        {
            "code": <int>, //0 for success, other for failure
            "message": <string>, // describes the error for failure, or record id for success
            "status": <success/duplicate>, // for success and duplicate results. for failure, will not exists.
            "repository assign id": <int> // relations id of the customers, or for the given customer
        }
    ],
    "id": <int> // id of the request
}

דוגמא לכישלון:

{
    "result": false,
    "data": [
        {
            "code": 12,
            "message": "IP [1.1.1.1] is not allowed for API 1"
        },
        {
            "code": 13,
            "message": "Authentication key mismatch for API 1"
        },
        {
            "code": 14,
            "message": "Incorrect request type for API 1"
        },
        {
            "code": 15,
            "message": "No customer fields found in request"
        }
    ],
    "id": "11337"
}

דוגמא להצלחה:

{
    "result": true,
    "data": [
        {
            "code": 0,
            "message": "4992062",
            "status": "success",
            "repository assign id": "4992062",
        }
    ],
    "id": "11308"
}

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

{
    "result": true,
    "data": [
        {
            "code": 40,
            "message": "Customer already exists",
            "status": "duplicate",
            "repository assign id": 4992063
        }
    ],
    "id": "11336"
}

רשימת קודי שגיאה עבור חוקי API

להלן רשימה מלאה של קודי השגיאה המוחזרים

error id	error message	explanation
0	<id of customer>	הצלחה, מחזיר את מזהה שיוך הלקוח למאגר במערכת
1	Empty request	התקבלה בקשה ללא שדות כלל
2	Authentication key not provided	התקבלה בקשה ללא מפתח זיהוי
3	Project needed but not exists	התקבלה בקשה ל-API כללי ללא מזהה פרויקט
10	API status is not active	ה-API המבוקש אינו פעיל
11	The Ip field is invalid	התרחשה שגיאה בפיענוח IP של מבקש הבקשה
12	IP [<ip>] is not allowed	התקבלה בקשה מכתובת IP לא מאושרת
13	Authentication key mismatch	מפתח האימות שהתקבל אינו תואם למפתח האימות שהוגדר לבקשה
14	Incorrect request type	סוג הבקשה שהתקבלה אינו תואם לסוג הבקשה שהוגדר
15	No customer fields found in request	לא נמצאו שדות לקוח בבקשה שהתקבלה
17	No API rule found for given auth_key	לא נמצאה הגדרת API עבור מפתח האימות שהתקבל
18	No API rule found for rule fields	לא נמצאה הגדרת API עבור שדה החיפוש שהוגדר (sid)
19	Api rule is inactive for the given field	שיוך חוק ה-API לפי שדה החיפוש שהוגדר אינו פעיל
20	Requests limit exceeded	מספר הבקשות שהתקבלו חורגות מהמותר
21	Failed requests limit exceeded	מספר הבקשות שנכשלו חורגות מהמותר
30	Invalid phone fields found	שדה טלפון שהתקבל לא תקין
31	Phone <field id> (phone type) invalid	הערך <field id> אינו מספר טלפון תקין
32	Fholder <fieldnumber> is invalid	הערך בשדה <fieldnumber> אינו תקין
40	Record already exists	הלקוח קיים במערכת וסומן ככפול לפי הגדרות בקשת ה-API
41	Insert customer status error	קביעת סטטוס ללקוח נכשלה
42	Insert customer details error	הכנסת פרטי הלקוח לבסיס הנתונים נכשלה
43	Black list customer	לקוח ברשימה שחורה
99	Could not insert request	התרחשה שגיאה בהכנסת הבקשה לבסיס הנתונים