RS04 - Automic REST API Einführung

In diesem Video lernst du, wie du die Automic REST API verwenden kannst. Marcin zeigt dir die Grundlagen der API und wie du Anfragen über Tools wie Postman sendest. Du lernst, wie du Jobs startest und Informationen aus dem Prozess-Monitoring abrufst. Außerdem werden Authentifizierungsmethoden und nützliche Tipps zur Verwendung der API besprochen. Perfekt für alle, die mehr über die Möglichkeiten der Automic REST API erfahren möchten!

ℹ️ Dieses Automic Tutorial ist Teil des REST-Lernpfades auf PEM und wurde am 26. November 2024 veröffentlicht.

📋 Inhalt: 1 Lektion

🕒 Dauer: 10 Minuten

Seit der Version 12.1 bietet Automic die Möglichkeit, über eine REST API mit der Plattform zu interagieren. In diesem Beitrag zeigt dir Marcin wie du die ersten Schritte mit der Automic REST API machst und was du dabei beachten solltest. Danach wirst du verstehen, wie du die API nutzen kannst, um Prozesse zu automatisieren und Informationen abzufragen.

Was ist die Automic REST API?

Die Automic REST API ist eine Schnittstelle, die dir ermöglicht, über HTTP-Anfragen mit deiner Automic-Umgebung zu kommunizieren. Mit ihr kannst du zum Beispiel Aufgaben überwachen, Jobs starten und Reports abrufen. Der große Vorteil: REST APIs sind standardisiert und lassen sich leicht mit Tools wie Postman oder über einfache curl-Befehle bedienen.

Vorbereitung: REST API Dokumentation und Postman

Bevor du loslegen kannst, solltest du die REST API Dokumentation zur Hand haben. Diese findest du im OpenAPI-Format auf der Herstellerseite von Automic. Die Dokumentation beschreibt alle verfügbaren Endpunkte, deren Funktionen sowie Beispiele für Rückgabewerte. Besonders praktisch: Die JSON-Dokumentation lässt sich direkt in Postman importieren.

Um loszulegen, kopierst du den Link zur JSON-Dokumentation und importierst ihn in Postman. Alle verfügbaren Endpunkte werden dann automatisch vorkonfiguriert und stehen dir zur Verfügung.

Authentifizierung und Grundeinstellungen

Bevor du eine Anfrage über die API stellst, musst du zwei wichtige Schritte erledigen. Zuerst richtest du die Authentifizierung ein. In Postman wählst du die Basic Authentication und gibst deinen Benutzernamen sowie Passwort ein. In neueren Versionen von Automic (ab Version 24.2) kannst du auch Bearer Tokens zur Authentifizierung nutzen.

Erste Anfrage: Aufgaben überwachen

Ein gängiger Anwendungsfall ist das Abrufen einer Liste von laufenden Aufgaben. Hierfür verwendest du den Endpunkt /executions. Nachdem du den Mandanten und die BaseURL konfiguriert hast, kannst du die Anfrage abschicken und erhältst als Antwort eine Liste aller aktuell laufenden Aufgaben.

Ein Tipp: Mit Postman kannst du auch Code-Snippets für verschiedene Programmiersprachen erstellen. Diese Snippets kannst du in deinen eigenen Automatisierungsprozessen verwenden.

Jobs starten mit der REST API

Ein weiteres beliebtes Szenario ist das Starten von Jobs über die REST API. Hierfür wechselst du beim gleichen Endpunkt von der GET- zur POST-Methode. In der Anfrage übergibst du das gewünschte Job-Objekt, und die API liefert dir eine RunID zurück, die den gestarteten Job eindeutig identifiziert.

Automic lernen mit PEM

Möchtest du mehr über Automic lernen, ohne deshalb für Workshops durchs Land reisen zu müssen? Bei PEM entscheidest du, wann und wie du dich weiterbilden möchtest! In interaktiven Kursen, Tutorials und Videos lernst du alles Wissenswerte rund um Automic. Und via Live-Sessions, Kommentarfunktion oder E-Mail sind wir jederzeit für dich da.

Hört sich das interessant an? Dann lege heute noch los mit PEM, dem Automic Training 2.0 und einer ganzjährigen Automic-Betreuung!

Member werden
Kostenlos testen

FAQ zum Automic Training auf PEM

PEM ist die innovativste und größte deutschsprachige Automic-Lernplattform. Sie bietet den PEM-Mitgliedern ein umfassendes Online-Schulungsangebot, auf das 24/7 und von überall aus zugegriffen werden kann. Die Plattform umfasst Hunderte Videos und interaktive Kurse und richtet sich an Einsteiger und Profis gleichermaßen.