RS04 - Automic REST API Einführung

ℹ️ 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!
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.
Um verschiedene Bedürfnisse zu erfüllen, gibt es bei PEM verschiedene Arten von Inhalten: Kurse, Tutorials, Lernpfade, Labore, Tools und Live-Sessions.
- In den Kursen und Tutorials lernst du in kurzweiligen und interaktiven Videos alles über Automic.
- Die Lernpfade bieten eine vollumfängliche Ausbildung zu einem bestimmten Automic-Thema. Als Anfänger eignet sich beispielsweise der 11-teilige Operator-Lernpfad. Bist du bereits Automic-Experte? Dann lernst sicher auch du noch etwas mit dem Datenbank-SQL Lernpfad.
- Labore sind Automic-Umgebungen, die auf Knopfdruck bereitgestellt werden und in denen das Gelernte in die Praxis umgesetzt werden kann.
- Auf PEM werden regelmäßig Tools mit passender Anleitung bereitgestellt. Damit lassen sich Automic-Prozesse noch weiter automatisieren und vereinfachen.
- In regelmäßigen Abständen finden Live-Sessions statt, bei denen wir aktuelle News und bestimmte Automic-Themen besprechen, und Fragen unserer Member beantworten.
Bei normalen Automic-Schulungen steht dir der Trainer ein paar Tage zur Verfügung. Wenn du Glück hast, kannst du vielleicht schon vor der Schulung Input liefern, und wenn du besonders viel Glück hast, dann kannst du in den Wochen nach der Schulung noch 1-2 Fragen nachschießen.
Unsere Mitglieder können uns jederzeit eine E-Mail schicken. Kleine Fragen beantworten wir gleich per E-Mail, größere Fragen nehmen wir mit in die nächste Live-Session und beantworten sie dort. Bei Fragen zu bestimmten Themen steht unseren Membern außerdem die Kommentarfunktion zur Verfügung. Das nennen wir “ganzjährige Automic Betreuung”.
Für die direkte Kommunikation gibt es bei uns die Live-Sessions: 24 Live-Sessions pro Jahr. Admin-Member dürfen bei jedem teilnehmen, Designer bei jedem zweiten, und Operator vier Mal im Jahr. In den Live-Sessions sind Fragen zu jedem Automic-Thema herzlich willkommen! Member haben die Möglichkeit, ihre Fragen vorab zu stellen, damit wir uns auf die Antwort und die Diskussion vorbereiten können.
Außerdem bieten wir sogenanntes Online Consulting. Das sind exklusive Videokonferenz-Session mit unseren Automic-Experten. Das Beste daran: Member, die über ein Kontingent für Online-Consulting verfügen, haben jederzeit Zugriff auf die Kalender unserer Spezialisten, und können dort direkt ihre Sessions buchen.
Enterprise-Kunden haben automatisch ein Kontingent dabei. Alle anderen können das dazu buchen.
Die Membership schließt du immer für ein Jahr ab. Danach verlängert sie sich normalerweise automatisch.
Bis einen Monat vor Ablauf kannst du jederzeit mit einer einfachen E-Mail kündigen. Natürlich kannst du die Membership bereits bei Vertragsbeginn auf ein Jahr beschränken.