ה-API של Atera מציע מגוון דרכים לשילוב והרחבת הפונקציונליות של Atera. השתמשו ב-API שלנו כדי להתחבר בקלות למערכת הנהלת החשבונות שלכם, לשפר את יעילות הצוות וליצור אינטגרציות חלקות.
החשבון שלכם מוגן באמצעות מפתח גישה ייחודי ל-API (REST API). כדי להשתמש ב-API של Atera, עליכם להתחבר עם מפתח זה.
הערה: Atera תומכת בבקשות API רק דרך HTTPS.
הצגת מפתח ה-API של Atera
כדי להציג את מפתח ה-API שלך:
1. מהתפריט הצדדי, בחרו ניהול מערכת ואז עברו אל ניהול נתונים > API.
עמוד API יופיע.
3. לחצו על אייקון העין כדי להציג את מפתח ה-API שלכם.
הערה: תצטרכו לספק מפתח זה בכל בקשה ל-API של Atera. שמרו על המפתח הזה בסוד ובטוח, כי הוא חושף את אנשי הקשר והמכשירים שלכם. אם יש צורך לאפס את המפתח, לחצו על אפס את מפתח ה-API שלי (איפוס המפתח יגרום לכך שכל בקשה עם המפתח הישן תיכשל).
התחברות עם מפתח ה-API של Atera
כדי להתחבר עם מפתח ה-API שלך:
1. מהתפריט הצדדי, בחרו ניהול מערכת ואז עברו אל ניהול נתונים > API.
עמוד API יופיע.
2. לחצו על תיעוד API. עמוד התיעוד של ה-API של Atera ייפתח בלשונית חדשה.
3. לחצו על התחבר בפינה הימנית העליונה של העמוד. חלון הרשאות זמינות יופיע.
4. הזינו את מפתח ה-API שלכם ולחצו על Authorize.
ה-API מאפשר גישה לסוגי נתונים רבים, כולל:
| סוכנים | MachineID, AgentID, DeviceGUID, FolderID, CustomerID, CustomerName ועוד. |
| התראות | AlertID, Code, Source, Title, Severity, Created, SnoozedEndDate ועוד. |
| חיוב | InvoiceID, InvoiceNumber, InvoiceNumberAsString, Total, Subtotal, Tax ועוד. |
| אנשי קשר | EndUserID, CustomerID, CustomerName, JobTitle, Email, Phone ועוד. |
| חוזים | CustomerID, ContractName, ContractType, Active, Taxable, StartDate ועוד. |
| לקוחות | CustomerID, CustomerName, CreatedOn, LastModified, Domain, Address ועוד. |
| ערכים מותאמים אישית | ItemID, ID, FieldName, ValueAsString, ValueAsDecimal, ValueAsBool ועוד. |
| מכשיר | Name, DeviceID, DeviceGuid, CustomerID, CustomerName, MntrngAgentID ועוד. |
| מאגר ידע | KBID, KBTimestamp, KBContext, KBProduct, KBLastModified ועוד. |
| תעריפים | RateID, Amount, Description, SKU, וקטגוריה. |
| קריאות שירות | TicketID, TicketTitle, EndUserID, EndUserEmail, TicketResolvedDate, תגובות לקריאה, קבצים מצורפים לקריאה ועוד. |
הערה: נקודת הקצה של קריאות השירות כוללת שדה שמכיל את כל התגובות לקריאה בפורמט HTML, כדי לאפשר שליפה של קבצים וקבצים מצורפים מהתגובות לקריאה.
דוגמאות
כדי לקבל את רשימת הסוכנים כמחרוזת curl:
1. היכנסו ל-https://app.atera.com/he/apidocs. עמוד ה-API של Atera ייטען. אם עדיין לא התחברתם, התחברו
2. לחצו על Agent. שיטות Agent ייפתחו.
3. לחצו על GET /api/v3/agents.
4. לחצו על Try It Out! מחרוזת curl תיווצר אוטומטית.
בתיבת התגובה (Response Body) יופיע מידע על כל סוכן.
כדי לקבל את רשימת הלקוחות כמחרוזת curl:
1. היכנסו ל-https://app.atera.com/he/apidocs. עמוד ה-API של Atera ייטען. אם עדיין לא התחברתם, התחברו
2. לחצו על Customer.
3. לחצו על GET /api/v3/customers.
4. לחצו על Try It Out! מחרוזת curl תיווצר אוטומטית.
בתיבת התגובה (Response Body) תוצג רשימת כל הלקוחות והמידע המשויך אליהם.
כדי לעדכן לקוח:
הערה: כדי לבצע קריאה זו בשיטת PUT בהצלחה, תצטרכו את מזהה הלקוח (customerID). ראו את הדוגמה הקודמת או בדקו את כתובת ה-URL כשאתם נמצאים בעמוד הלקוח הרלוונטי.
1. היכנסו ל-https://app.atera.com/he/apidocs. עמוד ה-API של Atera ייטען. אם עדיין לא התחברתם, התחברו
2. לחצו על Customer.
3. לחצו על PUT /api/v3/customers/{customerID}.
4. הזינו את מזהה הלקוח (customerID).
5. לחצו בכל מקום בתוך התיבה בצד ימין של העמוד כדי להציג את שדות הלקוח.
6. בצעו את השינויים הרצויים.
7. לחצו על Try it out! מחרוזת curl תיווצר אוטומטית.
הלקוח עודכן. ב-Response Body תראו איזה לקוח עודכן וב-Response Code תראו שהפעולה הצליחה.
