API, ראשי תיבות של Application Programming Interface (ממשק תכנות יישומים), מתייחס למנגנון שבאמצעותו רכיבי תוכנה שונים מתקשרים זה עם זה. בהקשר זה, "יישום" כולל כל תוכנה עם פונקציונליות מסוימת, בעוד ש"ממשק" הוא למעשה הסכם שירות בין שני יישומים. הסכם זה מגדיר את כללי התקשורת ביניהם, הכוללים בקשות ותשובות.
הערה חשובה: שימו לב, צוות התמיכה של Atera אינו מספק סיוע ביצירת או פתרון בעיות בחיבורי API.
שאלות נפוצות
בחלק זה תמצאו תשובות לשאלות הנפוצות ביותר בנוגע ל-API של Atera.
ש: מהו API?
ת: ממשק תכנות יישומים, או בקיצור API, הוא אמצעי שמאפשר לתוכנות שונות להחליף מידע ולתקשר ביניהן. למעשה, מדובר בממשק תוכנה שמספק שירות לרכיבי תוכנה אחרים.
ש: האם ל-Atera יש API?
ת: כן, ל-Atera יש API שמאפשר לכם לשלב רכיבים שונים של Atera עם יישומי תוכנה אחרים.
ש: מה העלות של שילוב API?
ת: מודול ה-API ב-Atera כלול במנוי שלכם ללא עלות נוספת. עם זאת, חשוב לדעת שבתקופת הניסיון (Trial) אין גישה ל-API.
ש: מה ניתן לעשות באמצעות ה-API של Atera?
ת: עם ה-API של Atera תוכלו לשלב את Atera עם יישומים שונים, כמו WhatsApp, Slack ו-Teams. שילוב זה מאפשר, למשל, ליצור אוטומטית קריאות שירות ב-Atera ישירות מהפלטפורמות הללו, ולקבל התראות או עדכונים על קריאות ב-WhatsApp, Slack ו-Teams כאשר מתרחש אירוע ב-Atera. בנוסף, ה-API מאפשר לכם לשלוף מידע על סוכנים, קריאות והתראות כדי לבנות לוח בקרה מותאם אישית (Dashboard) להצגה על מסך במשרד. ניתן גם להקים טופס אינטרנט באתר שלכם שדרכו לקוחות יוכלו לפתוח קריאות ישירות ב-Atera. האפשרויות עם ה-API של Atera מגוונות וגמישות.
ש: האם ניתן לקבל ייצוא ישיר או עותק של כל תגובות הקריאות והיסטוריית המיילים, או להגדיל את מגבלת ה-API לצורך גיבויים?
ת: לא, Atera אינה מספקת ייצוא ישיר או עותק מהשרת של כל תגובות הקריאות והיסטוריית המיילים. נכון לעכשיו, ה-API הוא הדרך היחידה הנתמכת לשליפת נתוני קריאות מלאים, כולל כל שרשור התגובות והיסטוריית המיילים.
אם אתם צריכים לגבות או לייצא את כל נתוני הקריאות והתגובות, תצטרכו לעבוד במסגרת מגבלות ה-API הקיימות. כדי להצליח לשלוף את המידע, מומלץ:
לחלק את הבקשות שלכם ל-API למנות (Batch).
להוסיף השהיות או האטה (Throttling) בסקריפטים שלכם.
לפזר את תהליך הייצוא על פני זמן ארוך יותר כדי למנוע כשלים או קריסות.
ש: האם ניתן לשלב כל יישום תוכנה דרך ה-API?
ת: לא, כדי לשלב יישום אחר עם Atera, גם ליישום השני חייב להיות API משלו.
ש: האם צריך ידע בפיתוח כדי לשלב את Atera עם יישומים אחרים דרך ה-API?
ת: כן, כדי לבצע שילוב מוצלח עם ה-API, נדרש ידע בסיסי בשפות תכנות כמו JavaScript או Python. בנוסף, חשוב להכיר היטב את עקרונות העבודה עם HTTP/HTTPS ו-RESTful.
ש: באיזה כלי וגרסה של API משתמשת Atera?
ת: Atera משתמשת ב-Swagger V3 לניהול ה-API שלה.
ש: מה המטרה של סוגי הבקשות השונים, כמו GET, POST, DELETE ו-PUT?
ת: לכל סוג בקשה יש תפקיד שונה:
- GET משמש לשליפת מידע מהרכיבים הזמינים ב-API. לדוגמה, ניתן להשתמש ב-GEТ כדי לשלוף מידע על סוכנים ולבנות דוחות.
- POST משמש להזנת נתונים למערכת שלכם ב-Atera. לדוגמה, בקטע הקריאות, POST משמש ליצירת קריאה חדשה.
- PUT דומה ל-POST בכך שגם הוא מוסיף נתונים, אך ההבדל הוא ש-PUT משמש לעדכון רשומות קיימות, בעוד POST יוצר רשומות חדשות.
- DELETE כפי שמשתמע מהשם, משמש למחיקת רשומה מסוימת במערכת שלכם ב-Atera.
ש: אילו נתונים ניתן לגשת אליהם או להוסיף ל-Atera דרך ה-API?
ת: ה-API מספק מגוון אפשרויות ברכיבים שונים של Atera:
- סוכנים: ניתן לבצע GET או DELETE לנתונים של סוכני Windows, Mac ו-Linux שלכם.
- התראות: ניתן לבצע GET, POST ו-DELETE על מידע התראות במערכת שלכם ב-Atera.
- חיוב: ניתן לשלוף (GET) מידע על חשבוניות שלכם ב-Atera.
- אנשי קשר: ניתן לבצע GET, POST, PUT ו-DELETE על אנשי קשר בסביבת Atera שלכם.
- חוזים: ניתן לקבל מידע על החוזים שלכם באמצעות ה-API.
- לקוחות: עבור מידע על לקוחות, יש לכם שליטה מלאה דרך ה-API, כולל GET, POST, PUT ו-DELETE.
- ערכים מותאמים אישית: ניתן לבצע GET או PUT לנתונים של שדות מותאמים אישית במערכת שלכם ב-Atera.
- מכשירים: ניתן לבצע GET, POST או PUT למכשירי ניטור, כולל SNMP, TCP, HTTP ומכשירים כלליים. אפשרות ה-POST מאפשרת ליצור מכשירי ניטור ישירות מה-API, וכך לייבא אותם מתוכנות אחרות.
- מאגר ידע: ה-API מאפשר לשלוף (GET) מידע ממאמרי הידע שלכם, כך שתוכלו להחזיק עותק של מאגר הידע באתר פנימי.
- תעריפים: ניתן לנהל את תעריפי החוזים שלכם דרך ה-API, עם אפשרויות GET, POST, PUT או DELETE.
- קריאות: כל סוגי הבקשות זמינים לפעולות על קריאות: GET, POST, PUT או DELETE. ניתן לשלוף מידע על קריאות, ליצור קריאות חדשות, לעדכן קריאות קיימות או למחוק אותן.
ש: האם אפשר להגדיר בקשות או פעולות API מותאמות אישית מעבר למה שמופיע כאן?
ת: לא, לא ניתן להתאים אישית את ה-API. הבקשות והפעולות האפשריות מוגבלות לאלו שמופיעות בשאלה הקודמת.
ש: האם יש מאמרים שמדגימים כיצד להשתמש ב-API?
ת: כן, למידע מפורט על שימוש ב-API של Atera, עיינו במאמר הבא.
ש: איך מבצעים אימות (Authentication) מול ה-API של Atera?
ת: האימות מתבצע באמצעות מפתח ה-API שלכם, אותו ניתן להפיק מחשבון ה-Atera שלכם תחת ניהול > API. כל בקשה חייבת לכלול את המפתח הזה בכותרת ההרשאה (Authorization Header).
האם אפשר לבדוק קריאות API לפני שמיישמים אותן?
ת: כן, ניתן להשתמש ב-ממשק ה-API (הנמצא בתוך Atera) או בכלי כמו Postman כדי לבדוק את נקודות הקצה של ה-API בצורה בטוחה לפני שמיישמים אותן בסביבת ייצור.
ש: מה לעשות אם קריאות ה-API שלי נכשלות?
ת: אם בקשה נכשלה, בדקו את הדברים הבאים:
שה-API Key שלכם תקף ומופיע בכותרת (Header).
שכתובת ה-Endpoint ושיטת הבקשה (GET, POST וכו') נכונות.
שגוף הבקשה (Request Body) בפורמט JSON תקין.
אם הבעיה נמשכת, בדקו את הודעת השגיאה שמתקבלת או עיינו בתיעוד ה-API של Atera.
ש: האם ניתן לצפות בלוגים של ה-API או לעקוב אחרי פעילות ה-API?
ת: כרגע, אין אפשרות לצפות בלוגים ייעודיים של ה-API בתוך המערכת של Atera. עם זאת, ניתן להשתמש בכלי ניטור חיצוניים או מערכות Logging כדי לעקוב אחרי הבקשות והתשובות.
ש: שמתי לב שמספר הקריאות מה-API /lastmodified לא תואם לדוח Timesheet שמסונן לפי Work Hour Date. למה?
ת: זה קורה כי כל אחד מהם משתמש בכללי סינון שונים לקריאות:
API
/lastmodified: בודק את הפעילות האחרונה בכל קריאה. אם הפעילות האחרונה התבצעה בתאריך שבחרתם או אחריו, הקריאה תוחזר.דוח Timesheet (סינון לפי Work Hour Date): בודק מתי נרשמו שעות עבודה על קריאה. אם נרשמו שעות עבודה בטווח התאריכים שבחרתם, הקריאה תופיע בדוח.
