חוקי 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

integromat (make)

נדגים יצירת קישור API בין פרסום פייסבוק למערכת CRM על-ידי המערכת integromat (make):

הערה: נדרש לאשר את כתובת ה IP לפי השרת עליו ה integromat שלכם יושב (בדר"כ זה יהיה eu1) כפי שמוצג במסמך באתר הרשמי integromat (make).

1. אם נרצה לקשר חוק API קיים אפשר להתקדם לשלב הבא. במידה ואין חוק API קיים או שנרצה לקשר לחוק API חדש, יש ליצור חוק API חדש לפי השלבים שמופיעים בראש העמוד תחת "יצירת חוק API".
2. נתחבר ל integomat ונקשר את הפרסום בפייסבוק (או בכל אתר אחר) ל integromat.
3. נלחץ על הפלוס שמופיע ב "router"
   
4. נבחר HTTP
   
5. לאחר מכן תפתח רשימת אפשרויות, ונבחר "Make a request"
   
6. נחזור למערכת ה CRM, נלחץ מקש ימני על חוק ה API שאותו נרצה לקשר ונבחר הצג קישור.
   
7. לפני השדות שמופיעים בקישור כך נמלא את הפרטים ב integromat.
   
   
   יש להוסיף תחת Query string:
   1. auth_key: ולהעתיק את הקישור עד את המספר החל מ "AUTKEY=" ועד ל "&f1" (כפי שמופיע בתמונה בשלב 8).
   2. f1: ולרשום ולבחור את השדה שהופיע ליד f1 בקישור.
   3. f2: ולרשום ולבחור את השדה שהופיע ליד f2 בקישור.
   4. f3: ולרשום ולבחור את השדה שהופיע ליד f3 בקישור.
   5. במידה וחוק ה API יכיל יותר תאים או פחות כמות ה fים תהיה גדולה או קטנה בהתאמה.
8. נלחץ מקש ימני על המודל שכעת יצרנו ונבחר "Run this module only" כדי לבדוק האם החוק שיצרנו עובד.
   
9. נמלא פרטי בדיקה ונלחץ "OK"
   
10. כעת נחזור לחוק ה API, נלחץ עליו מקש ימני ונבחר: "היסטורית בקשות".
    
    בסיום התהליך נאכל לראות כי הסטטוס הוא "בהצלחה" וזה אומר שהקישור עובד באופן תקין.
11. במידה ונקבל סטטוס "כישלון" זה יכול להיות מכמה סיבות:
    1. ה method של ה API ב integromat וב CRM שונה. (לדוגמא, אחד מהם מוגדר על post והשני על get).
    2. צריך לוודא שה-IPים שהגדרנו בעת היצירה תואמים למה שנדרש מהמערכת אליה אנחנו מנסים להתחבר, לדוגמא integromat דורשים שיהיו כל ה IPים בין: 82.208.14.119 - 82.208.14.110.

zapier

נדגים יצירת קישור API בין פרסום פייסבוק למערכת CRM על-ידי המערכת zapier:

הערה: המערכת zapier עובדת לפי כתובות IP רנדומליים ולכן מצריכה אישור של כל כתובת ה IP, פעולה זו בעצם תאפשר לכל מי שיהיה לו את הקישור API שלכם להעביר אליכם את הליד.

לכן חשוב מאוד לא להעביר את הקישור API לאף גורם מלבד להתממשקות מול zapier.

1. אם נרצה לקשר חוק API קיים אפשר להתקדם לשלב הבא. במידה ואין חוק API קיים או שנרצה לקשר לחוק API חדש, יש ליצור חוק API חדש לפי השלבים שמופיעים בראש העמוד תחת "יצירת חוק API".
2. נתחבר ל zapier ונקשר את הפרסום בפייסבוק (או בכל אתר אחר) ל zapier.
   
3. נלחץ על ה + ונוסיף zapier formatter
   
4. ב Event נבחר באפשרות של : TEXT.
5. ב Action נבחר:
   1. ב Transform נבחר "Replace".
   2. ב Find נרשום "+9720" (ללא "", כפי שמופיע בתמונה)
   3. ב Replace נרשום "0" (ללא "", כפי שמופיע בתמונה)
      
6. נלחץ על ה + ונוסיף webhooks.
   
7. ב Event נבחר את שיטת הגישה לחוק כפי שהגדרנו ב"יצירת חוק API" שלב (1).
8. נחזור למערכת ה CRM, נלחץ מקש ימני על חוק ה API שאותו נרצה לקשר ונבחר הצג קישור.
   
9. לפני השדות שמופיעים בקישור כך נמלא את הפרטים בזאפייר תחת ה Action של ה webhook. הערה: ב URL נעתיק מהקישור מההתחלה ועד ל "?" (כפי שמופיע בתמונה בשלב 8)
   
10. יש להוסיף תחת Data:
    1. auth_key: ולהעתיק את הקישור עד את המספר החל מ "AUTKEY=" ועד ל "&f1" (כפי שמופיע בתמונה בשלב 8).
    2. f1: ולרשום ולבחור את השדה שהופיע ליד f1 בקישור.
    3. f2: ולרשום ולבחור את השדה שהופיע ליד f2 בקישור.
    4. f3: ולרשום ולבחור את השדה שהופיע ליד f3 בקישור.
11. לסיום נלחץ על "Test action" כדי לבצע בדיקה ולראות שלידים יוכלו להיכנס בצורה תקינה למערכת.
    
12. כעת נחזור לחוק ה API, נלחץ עליו מקש ימני ונבחר: "היסטורית בקשות".
    
    בסיום התהליך נאכל לראות כי הסטטוס הוא "בהצלחה" וזה אומר שהקישור עובד באופן תקין.
13. במידה ונקבל סטטוס "כישלון" זה יכול להיות מכמה סיבות:
    1. ה method של ה API ב zapier וב CRM שונה. (לדוגמא, אחד מהם מוגדר על post והשני על get).
    2. במידה והליד מגיע בהצלחה אך הוא ריק מפרטים, יש לבצע את הבדיקות כאן.
       
    3. צריך לוודא שה-IPים שהגדרנו בעת היצירה תואמים למה שנדרש מהמערכת אליה אנחנו מנסים להתחבר, לדוגמא zapier דורשים שיהיו כל ה IPים ולכן צריך להיות סימן של *