EAM Tool APIs am Beispiel von EAS Cloud

Enterprise Architecture Tools- APIs

Enterprise Architecture Management (EAM) Tools können Prozesse erheblich optimieren und automatisieren. Ein essenzieller Baustein dafür ist die Nutzung von APIs. In diesem Artikel zeigen wir anhand der EAS Essential Cloud Enterprise Architektur Software, wie sich grundlegende Daten mittels APIs auslesen lassen.

Mit APIs kann die EAM-Software programmgesteuert genutzt werden. Wir fokussieren uns auf folgende Aspekte:

1 Konfiguration von Essential Cloud 2 Notwendige API Parameter für den Zugriff 3 Authentifizierung 4 Auslesen von Applikationen

Das Essential Project ist im Gartner Magic Quadrant für EAM-Tools unter dem Firmennamen Enterprise Architecture Solutions als Visionär aufgeführt. Die Software ist als kommerzielle SaaS Lösung und als kostenlose Open-Source-Lösung verfügbar.

Konfiguration von EAS

Um über die API auf EAS zuzugreifen, benötigen Sie einen technischen Benutzer, der innerhalb der Applikation angelegt wird. Benutzer, die über ein Verzeichnis synchronisiert werden, eignen sich nicht als API-User.

Der angelegte User muss über “System Administrator” Rechte verfügen, sowie als internal angelegt sein.

Notwendige API Parameter für den Zugriff

Für den Zugriff brauchen wir folgende Informationen:

• Username - des technischen Users
• Passwort
• EAS API Key
• EAS Repository ID

Der benötigte API Key findet sich in dern Settings des Administrators …

… unter dem “TENANT API KEY”:

Im Normalfall sind in EAS Cloud mehrere Repositories angelegt, in denen die EAM Daten zu finden sind. Um auf das richtige Repository zuzugreifen müssen wir den richtigen Repository Key finden.

Dazu wählen wir das gewünschte Repository in der Übersicht und Clicken auf “Capture”.

Aus der URL können wir dann die entsprechende ID kopieren “4141414141414141414141”.

Authentifizierung bei EAS

Der EAS Authentifizierungs Flow funktioniert nach dem OAuth 2.0 security schema.

Anbei der Beispielcode zur Authentifizierung and der EAS Instanz:

import requests
import json

# Essential Cloud API details
BASE_URL = "https://forwardnow.essentialintelligence.com/api"
TOKEN_URL = f"{BASE_URL}/oauth/token"
APPLICATIONS_URL = f"{BASE_URL}/essential-utility/v2/repositories/41414141414141.../classes/Application_Provider_Role/instances"

# Replace with your actual credentials
API_KEY = "DEADBEEFDEADBEEF..."
USERNAME = "kai.herings@fwdnow.io"
PASSWORD = "geheim"

def get_bearer_token():
    """Fetch a new bearer token for authentication."""
    headers = {
        "Content-Type": "application/json",
        "x-api-key": API_KEY
    }
    payload = {
        "grantType": "password",
        "username": USERNAME,
        "password": PASSWORD
    }
    
    response = requests.post(TOKEN_URL, headers=headers, json=payload)
    
    if response.status_code == 200:
        token_data = response.json()
        return token_data["bearerToken"]
    else:
        print(f"Error fetching token: {response.json()}")
        return None

Mit diesem Snippet erhalten wir das benötigte Bearer Token, was wir für den Abruf der Daten im weiteren verwenden.

Auslesen von Applikationen

Jetzt kommen wir zum eigentlichen Auslesen der Daten. Die Applikationen, die zur Anwendung kommen sind im Metaodell unter dem Objekt “Application Provider Role” zu finden. Dieses fragen wir jetzt über die API an und geben den Namen der Applikation auf Basis des zurückgelieferten JSON aus.

Der code zum Abruf der Applikationsnamen ist der Folgende:

def fetch_applications():
    """Retrieve all applications from the Essential Cloud API."""
    bearer_token = get_bearer_token()
    
    if not bearer_token:
        print("Failed to retrieve a valid bearer token.")
        return
    
    headers = {
        "Content-Type": "application/json",
        "x-api-key": API_KEY,
        "Authorization": f"Bearer {bearer_token}"
    }
    
    response = requests.get(APPLICATIONS_URL, headers=headers)
    data = response.json()

    # Extract names from instances
    names = [instance.get("name") for instance in data.get("instances", [])]

    # Print the names
    i = 0
    for name in names:
        i = i + 1
        print(i,name)
    
# Execute the API call
print("\n📢 [fwdnow.io - EAM Consulting] Code Example - Extracted Application Provider Roles:\n")
fetch_applications()

Das Programm generiert den folgenden Output:

Anwendungsfälle für eine API-Integration von EAM-Lösungen

Die Integration von Enterprise Architecture Management (EAM)-Lösungen in Unternehmensprozesse bietet zahlreiche Vorteile, insbesondere durch eine programmatische Anbindung über APIs. Dadurch können verschiedene Abläufe effizienter gestaltet, automatisiert und nahtlos in bestehende Systeme integriert werden.

Einige typische Anwendungsfälle für eine API-gestützte EAM-Integration sind:

1. Software-Beschaffung und Lizenzmanagement

Beim Einkauf neuer Softwarelösungen können diese automatisch in der EAM-Lösung erfasst und mit bestehenden Architekturen abgeglichen werden. Dies ermöglicht eine bessere Übersicht über die IT-Landschaft und erleichtert die Compliance-Prüfung.

2. Deployment und Verwaltung von Proof-of-Concepts (PoCs)

Neue Testumgebungen oder Proof-of-Concepts können durch eine API-Anbindung direkt in der EAM-Lösung registriert werden. Dadurch behalten Enterprise Architekten den Überblick über experimentelle Lösungen und können frühzeitig strategische Entscheidungen treffen.

3. Automatisierte Erfassung von GitLab- und anderen Repositorys

Bei der Erstellung neuer Softwareprojekte können automatisch Repositories (z. B. in GitLab oder GitHub) in der EAM-Lösung dokumentiert werden. Dies sorgt für eine bessere Nachverfolgbarkeit der Entwicklungsprojekte und erleichtert das Architektur- und Technologiemanagement.

4. Automatisierte Dokumentation und Freigabeprozesse

Neue Applikationen oder Services können direkt über die API in der EAM-Lösung angelegt und mit Metadaten (z. B. verantwortliche Personen, technische Schulden, Abhängigkeiten) versehen werden. Anschließend können Enterprise Architekten die Daten überprüfen und notwendige Anpassungen vornehmen.

5. Integration mit IT-Service-Management (ITSM) und CMDBs

Durch eine API-Anbindung an ITSM-Tools wie ServiceNow oder CMDBs (Configuration Management Databases) können Änderungen in der IT-Landschaft automatisch in der EAM-Lösung erfasst werden, um eine stets aktuelle Architektur-Dokumentation sicherzustellen.

6. Automatisierte Abgleichung mit Cloud-Umgebungen

Cloud-Ressourcen und SaaS-Anwendungen (z. B. AWS, Azure, Google Cloud) können per API mit der EAM-Lösung synchronisiert werden, um Transparenz über die Cloud-Nutzung im Unternehmen zu gewährleisten.

Durch eine API-Integration kann die EAM-Lösung als zentrale Plattform für Architekturmanagement dienen und die manuelle Pflege erheblich reduzieren. Dies spart Zeit, erhöht die Datenqualität und verbessert die Zusammenarbeit zwischen verschiedenen IT- und Business-Stakeholdern.

Wir steigen mit Ihnen gerne weiter in dieses und weitere Themen ein: 1:1 Session buchen