API ומידע ממקור חיצוני - אסימונים ו-Webhooks
מדריך ללשונית API ומידע ממקור חיצוני ב-Quicker: יצירת אסימוני API (תפוגה והגבלת IP), הגדרת Webhooks לאירועי פרויקטים/לידים/משימות, ותיעוד למפתחים. שירות בתשלום - להפעלתו יש לפנות לצוות Quicker.
לשונית API ומידע ממקור חיצוני מאפשרת חיבור תוכנתי של Quicker למערכות חיצוניות - גישה ל-API לקריאה ויצירה של פרויקטים, לידים ומשימות, וכן Webhooks לקבלת עדכונים אוטומטיים כשמתרחשים אירועים במערכת.
שירות בתשלום: להפעלת שירות ה-API יש לפנות לצוות Quicker. השירות אינו נפתח עצמאית - לאחר ההפעלה הלשונית תהיה זמינה למנהלי הארגון.
אסימוני API
אסימון (טוקן) הוא מפתח גישה למערכות חיצוניות. בכפתור יצירת אסימון חדש יוצרים אסימון, ואפשר להגדיר לו:
- תאריך תפוגה - מועד שבו האסימון יפוג (אופציונלי).
- כתובת IP - הגבלת השימוש לכתובת מסוימת (אופציונלי; יש כפתור להגדרה ככתובת הנוכחית).
ערך האסימון מוצג ביצירה וניתן להעתקה; ברשימה הוא מוצג ממוסך, עם אפשרות הצגה והעתקה. אסימון אפשר למחוק (פעולה בלתי הפיכה).
הגבילו את האסימון בתאריך תפוגה ובכתובת IP כשאפשר - כך הגישה מאובטחת יותר. שמרו את ערך האסימון במקום בטוח; הוא מוצג במלואו רק ביצירה.
Webhooks - עדכונים אוטומטיים
Webhook שולח עדכון אוטומטי לכתובת שתגדירו כשמתרחש אירוע במערכת - שימושי לחיבור ל-Zapier, Slack או מערכת פנימית. בכפתור הוספת Webhook מגדירים:
- שם ה-Webhook.
- אירוע - בחירה מתוך אירועי המערכת, בשלוש קבוצות: פרויקטים (יצירת פרויקט, שינוי סטטוס, שינוי ציון דרך), לידים (יצירת ליד, שינוי סטטוס), ומשימות (יצירת משימה, שינוי סטטוס).
- URL - הכתובת שאליה יישלח העדכון.
- פעיל - אפשר להשבית Webhook זמנית בלי למחוק אותו.
אפשר להגדיר כמה Webhooks לאותו אירוע (למשל גם ל-Zapier וגם למערכת פנימית).
תיעוד למפתחים
בתפריט תיעוד למפתחים יש קישור למפרט ה-API (OpenAPI) ולכלי עיון אינטראקטיביים, עבור מי שמפתח את האינטגרציה.
הרשאות
לאחר הפעלת השירות, הלשונית זמינה למנהלי הארגון (ולמנהלי מערכת). משתמש רגיל אינו ניגש אליה.
דוגמאות שימוש
דוגמה 1: סנכרון פרויקטים למערכת חיצונית
המשרד מחבר מערכת חיצונית ל-API של Quicker בעזרת אסימון, כדי לשלוף ולעדכן פרויקטים אוטומטית.
דוגמה 2: התראה ב-Slack על ליד חדש
מגדירים Webhook לאירוע יצירת ליד שמפנה ל-Slack - וכל ליד חדש מפעיל הודעה בערוץ.
דוגמה 3: אוטומציה ב-Zapier
Webhook על שינוי סטטוס פרויקט מחובר ל-Zapier, שמריץ ממנו תהליך אוטומטי.
