Hilfe-CenterDie API von Atera bietet mehrere Methoden zur Integration und Erweiterung der Funktionen von Atera. Nutzen Sie unsere API zur einfachen Integration in Ihr Buchhaltungssystem, zur Steigerung der Produktivität Ihres Teams und zur Erstellung nahtloser Integrationen.
Ihr Konto ist durch einen eindeutigen API-Zugangsschlüssel (REST API) geschützt. Sie müssen sich mit diesem Schlüssel anmelden, um die API von Atera zu nutzen.
Hinweis: Ab dem 1. Juni werden wir nur noch API-Anfragen über HTTPS unterstützen. Falls Sie es noch nicht getan haben, ändern Sie bitte jede HTTP-API-Implementierung, die Sie haben, auf HTTPS, um eine sicherere Kommunikation zu gewährleisten. Wenn Sie bereits HTTPS verwenden, müssen Sie nichts weiter tun!
Dieser Artikel zeigt Ihnen, wie Sie Ihren Atera-API-Schlüssel aufdecken und wie Sie sich mit Ihrem Atera-API-Schlüssel anmelden können.
Um Ihnen weiterzuhelfen, zeigen wir Ihnen Beispiele für zwei GET-Anfragen sowie eine PUT-Anfrage:
Klicken Sie hier, um die API-Dokumentationsseite von Atera aufzurufen
So zeigen Sie Ihren API-Schlüssel an:
1. Klicken Sie in der Admin im Seitenbereich auf API.
Die API-Seite wird angezeigt.
3. Klicken Sie auf das Augensymbol 
, um Ihren API-Schlüssel anzuzeigen.
Hinweis: Sie müssen diesen Schlüssel bei jeder Anfrage an die Atera API angeben. Bitte bewahren Sie diesen Schlüssel geheim und sicher auf, da er Ihre Kontakte und deren Geräte offenlegt. Wenn Sie Ihren Schlüssel aus irgendeinem Grund zurücksetzen müssen, klicken Sie auf Meinen API-Schlüssel zurücksetzen (das Zurücksetzen des API-Schlüssels führt dazu, dass alle mit dem alten Schlüssel durchgeführten Anfragen fehlschlagen).
So melden Sie sich mit Ihrem API-Schlüssel an:
1. Klicken Sie in der Admin im Seitenbereich auf API.
Die API-Seite wird angezeigt.
2. Klicken Sie auf Dokumentation ansehen. Die Atera API-Dokumentationsseite wird in einer neuen Registerkarte geöffnet.
3. Klicken Sie auf Log in (Anmelden), oben rechts auf der Seite. Das Fenster Available authorizations (Verfügbare Berechtigungen) wird angezeigt.
4. Geben Sie Ihren API-Schlüssel ein. Klicken Sie dann auf Authorize (Autorisieren).
Die API ermöglicht Ihnen den Zugriff auf viele Datentypen, darunter:
| Agents (Agenten) | MachineID, AgentID, DeviceGUID, FolderID, CustomerID, CustomerName, etc. |
| Alerts (Benachrichtigungen) | AlertID, Code, Source, Title, Severity, Created, SnoozedEndDate, etc. |
| Billing (Abrechnung) | InvoiceID, InvoiceNumber, InvoiceNumberAsString, Total, Subtotal, Tax, etc. |
| Contacts (Kontakte) | EndUserID, CustomerID, CustomerName, JobTitle, Email, Phone, etc. |
| Contracts (Verträge) | CustomerID, ContractName, ContractType, Active, Taxable, StartDate, etc. |
| Customers (Kunden) | CustomerID, CustomerName, CreatedOn, LastModified, Domain, Address, etc. |
| CustomValues (Benutzerdefinierte Werte) | ItemID, ID, FieldName, ValueAsString, ValueAsDecimal, ValueAsBool, etc. |
| Device (Gerät) | Name, DeviceID, DeviceGuid, CustomerID, CustomerName, MntrngAgentID etc. |
| KnowledgeBase (Wissensdatenbank) | KBID, KBTimestamp, KBContext, KBProduct, KBLastModified, etc. |
| Rates (Preise) | RateID, Amount, Description, SKU, and Category. |
| Tickets (Tickets) | TicketID, TicketTitle, EndUserID, EndUserEmail, TicketResolvedDate, etc. |
Beispiele
Um die Agentenliste als Curl-String zu erhalten:
1. Gehen Sie zu https://app.atera.com/apidocs. Die Atera API-Seite wird geladen. Wenn Sie es noch nicht getan haben, melden Sie sich an
2. Klicken Sie auf Agent. Das Dropdown-Menü Agent-Methoden.
3. Klicken Sie auf GET /api/v3/agents.
4. Klicken Sie auf Try It Out! Curl wird erzeugt.
Der Antworttext zeigt die Agenteninformationen für jeden Agenten an.
So erhalten Sie die Kundenliste als Curl-String:
1. Gehen Sie zu https://app.atera.com/apidocs. Die Atera API-Seite wird geladen. Wenn Sie es noch nicht getan haben, melden Sie sich an
2. Klicken Sie auf Customer.
3. Klicken Sie auf GET /api/v3/customers.
4. Klicken Sie auf Try It Out! Curl wird erzeugt.
Der Antworttext zeigt eine Liste aller Kunden und ihrer zugehörigen Informationen an.
So aktualisieren Sie einen Kunden:
Um diesen PUT-Methodenaufruf erfolgreich zu implementieren, benötigen Sie die ID des Kunden. Sehen Sie sich unser vorheriges Beispiel an, oder schauen Sie sich Ihre URL an, wenn Sie auf der spezifischen Kundenseite sind.
1. Gehen Sie zu https://app.atera.com/apidocs. Die Atera API-Seite wird geladen. Wenn Sie es noch nicht getan haben, melden Sie sich an
2. Klicken Sie auf Customer.
3. Klicken Sie auf PUT /api/v3/customers/{customerID}.
4. Geben Sie die customerID ein.
5. Klicken Sie auf eine beliebige Stelle im Feld auf der rechten Hälfte der Seite, um das Kundenfeld auszufüllen.
6. Nehmen Sie die gewünschten Änderungen vor.
7. Klicken Sie auf Try It Out! Curl wird erzeugt.
Der Kunde ist aktualisiert. Der Response Body (Antworttext) zeigt, welcher Kunde aktualisiert wurde, und der Antwortcode zeigt, dass es ein Erfolg war.
Julian Kudo