API, ein Akronym für Application Programming Interface, bezieht sich auf einen Mechanismus, über den verschiedene Softwarekomponenten interagieren. In diesem Zusammenhang umfasst "Anwendung" jede Software mit einer bestimmten Funktionalität, während "Schnittstelle" als eine Dienstvereinbarung zwischen zwei Anwendungen verstanden werden kann. In dieser Vereinbarung werden die Protokolle für ihre Kommunikation mit Anfragen und Antworten festgelegt.
Wichtiger Hinweis: Bitte beachten Sie, dass der Atera-Support keine Unterstützung bei der Erstellung oder Fehlerbehebung von API-Verbindungen anbietet.
Häufig gestellte Fragen
In diesem Abschnitt werden die häufig gestellten Fragen zur Atera-API behandelt.
F: Was ist eine API?
A: Eine Anwendungsprogrammierschnittstelle (Application Programming Interface, API) dient als Mittel für den Informationsaustausch und die Interaktion zwischen mehreren Computerprogrammen. Im Wesentlichen fungiert sie als Softwareschnittstelle, die einen Dienst für andere Softwarekomponenten bereitstellt.
F: Verfügt Atera über eine API?
A: Ja, Atera bietet eine API, die es Ihnen ermöglicht, verschiedene Komponenten von Atera in andere Softwareanwendungen zu integrieren.
F: Wie hoch sind die Kosten für die API-Integration?
A: Das API-Modul in Atera ist als Teil Ihres Abonnements ohne zusätzliche Kosten enthalten. Beachten Sie jedoch, dass der API-Zugang während der Testphase nicht verfügbar ist.
F: Was kann mit der von Atera bereitgestellten API erreicht werden?
A: Mit der API von Atera können Sie Atera nahtlos in verschiedene Anwendungen wie WhatsApp, Slack und Teams integrieren. Diese Integration eröffnet Möglichkeiten für praktische Anwendungen, wie z. B. die Automatisierung der Ticketerstellung in Atera direkt von den genannten Plattformen aus und den Empfang von Alarm- oder Ticketbenachrichtigungen in WhatsApp, Slack und Teams, wenn Ereignisse in Atera auftreten. Darüber hinaus ermöglicht die API das Extrahieren von Agenten-, Ticket- und Alarminformationen, um ein individuelles Dashboard zu erstellen, das sich für die Anzeige auf einem Fernseher in Ihrem Büro eignet. Die API bietet auch die Möglichkeit, ein Webformular auf Ihrer Website einzurichten, mit dem Kunden direkt Tickets in Atera erstellen können. Die Möglichkeiten, die Ateras API bietet, sind umfangreich und anpassungsfähig.
F: Kann jede Softwareanwendung über die API integriert werden?
A: Nein, für die Integration mit Atera muss die andere Softwareanwendung ebenfalls über eine eigene API verfügen.
F: Sind für die Integration von Atera mit anderen Softwareanwendungen über die API Entwicklerkenntnisse erforderlich?
A: Ja, für eine erfolgreiche API-Integration sind Grundkenntnisse in Programmiersprachen wie JavaScript oder Python erforderlich. Darüber hinaus ist ein gutes Verständnis von HTTP/HTTPS und RESTful-Designprinzipien erforderlich.
F: Welches API-Tool und welche Version setzt Atera ein?
A: Atera verwendet Swagger V3 zur Steuerung seiner API.
F: Welchen Zweck erfüllen die verschiedenen Arten von Anfragen, wie GET, POST, DELETE und PUT?
A: Jede Art von Anfrage dient einer bestimmten Funktion:
-
GET wird zum Abrufen von Informationen aus den in der API verfügbaren Komponenten verwendet. Mit GET können Sie beispielsweise Agenteninformationen extrahieren und Berichte über Ihre Agenten erstellen.
-
POST wird verwendet, um Daten in Ihre Atera-Instanz einzugeben. Zum Beispiel wird die POST-Option im Ticket-Bereich verwendet, um neue Tickets in Atera zu erstellen.
-
PUT dient einem ähnlichen Zweck wie POST, da es ebenfalls verwendet wird, um Daten zu Ihrer Atera-Instanz hinzuzufügen. Der Hauptunterschied besteht jedoch darin, dass PUT zum Aktualisieren bestehender Einträge verwendet wird, während POST zum Erstellen neuer Einträge verwendet wird.
-
DELETE wird, wie der Name schon sagt, verwendet, um einen bestimmten Eintrag in Ihrer Atera-Instanz zu löschen.
F: Auf welche Daten kann man über die API zugreifen oder sie zu Atera hinzufügen?
A: Die API bietet verschiedene Funktionalitäten für unterschiedliche Komponenten von Atera:
-
Agenten: Mit der API können Sie Daten zu Ihren Windows-, Mac- und Linux-Agenten GETEN oder LÖSCHEN.
-
Alarme: Mit der API können Sie GET-, POST- und DELETE-Operationen für Alarminformationen innerhalb Ihrer Atera-Instanz durchführen.
-
Abrechnung: Sie können die API verwenden, um Informationen über Ihre Rechnungen innerhalb von Atera zu erhalten.
-
Kontakte: Die API bietet Optionen für GET-, POST-, PUT- und DELETE-Operationen für Kontakte innerhalb Ihrer Atera-Umgebung.
-
Verträge: Sie können über die API Informationen über Ihre Verträge abrufen.
-
Kunden: Für Kundeninformationen haben Sie eine umfassende Kontrolle über die API, einschließlich GET-, POST-, PUT- und DELETE-Operationen.
-
Benutzerdefinierte Werte: Mit dieser Funktionalität können Sie Daten zu Ihren benutzerdefinierten Feldern innerhalb Ihrer Atera-Instanz GET oder PUT abrufen.
-
Gerät: Sie können Überwachungsgeräte, einschließlich SNMP-, TCP-, HTTP- und allgemeine Geräte, GET, POST oder PUT. Mit der POST-Option können Sie Überwachungsgeräte direkt über die API erstellen, was den Import aus anderen Softwareanwendungen erleichtert.
-
Wissensdatenbank: Über die API können Sie Informationen aus Ihren Wissensartikeln abrufen, so dass Sie eine Kopie Ihrer Wissensdatenbank auf einer internen Website bereitstellen können.
-
Tarife: Sie können Ihre Vertragstarife über die API verwalten, mit Optionen für GET, POST, PUT oder DELETE.
-
Tickets: Alle Anfragetypen sind für ticketbezogene Vorgänge verfügbar: GET, POST, PUT oder DELETE. In diesem Bereich können Sie Ticketinformationen abrufen, neue Tickets erstellen, bestehende Tickets aktualisieren oder löschen.
F: Kann ich meine eigenen API-Anfragen oder Aktionen definieren, um mit Daten zu arbeiten, die über die oben genannten hinausgehen?
A: Nein, die Anpassung der API wird nicht unterstützt. Die verfügbaren API-Aufrufe und -Abfragen sind auf die in der vorherigen Frage aufgeführten beschränkt.
F: Gibt es Artikel, die die Verwendung der API demonstrieren?
A: Ja, detaillierte Informationen zur Nutzung der Atera-API finden Sie im folgenden Artikel.
F: Gibt es eine Beschränkung des Datenvolumens, das ich über die Atera-API verwalten kann?
A: Ja, es gibt eine Begrenzung der Anzahl der Anfragen pro Minute, die von Ihrem Abonnement abhängt. Für das niedrigste Abonnement liegt die Grenze bei 400 Anfragen pro Minute, während das höchste Abonnement mehr Anfragen pro Minute zulässt. Es ist wichtig, auch die API-Beschränkungen der Softwareanwendung zu berücksichtigen, die Sie mit der Atera-API integrieren möchten.