Azumutas REST-API
Hinweis: Dies ist ein hoch technischer Artikel. Wir empfehlen daher, Ihre IT‑Abteilung beim Lesen hinzuzuziehen. Bei Fragen oder Anliegen kontaktieren Sie uns bitte über support@azumuta.com – wir helfen Ihnen gerne weiter.
Unsere REST API verwendet standardmäßige HTTP-Antwortcodes und -Verben. Bei einer normalen GET-Anfrage werden die Daten als JSON-codierte Antworten zurückgegeben.
Authentifizierung
Die Azumuta API verwendet API-Schlüssel zur Authentifizierung von Anfragen. Senden Sie den Schlüssel im X-API-Key Request-Header (empfohlen). Sie können alternativ auch einen apiKey-Query-Parameter verwenden.
Erstellen und verwalten Sie Schlüssel unter Management → Devices → API. Siehe Erstellen und Verwalten von API-Schlüsseln.
Alle API-Anfragen müssen über HTTPS erfolgen. Über unverschlüsseltes HTTP ausgeführte Aufrufe schlagen fehl. API-Anfragen ohne Authentifizierung werden ebenfalls fehlschlagen.
Hinweis: Ihre API-Schlüssel sind streng vertraulich und dürfen niemals an Personen außerhalb Ihres Unternehmens weitergegeben werden und dürfen nicht im Browser-Client‑Code auftauchen.
Zugriff auf die API-Dokumentation
Die Azumuta REST API ist in den integrierten API-Dokumenten innerhalb der Anwendung dokumentiert:
- Klicken Sie oben rechts auf das Fragezeichen (Hilfe).
- Klicken Sie auf API docs.
Das öffnet die interaktive Referenz unter /docs/api in der Azumuta-Plattform. Dort können Sie Endpunkte für Azumuta-Module und Add-ons durchsuchen (außer Dashboards).
Wenn Sie authentifiziert sind, können Sie Endpunkte mit der Try it out-Schaltfläche live testen und das Ergebnis in Ihrer Azumuta-Plattform sehen.
Workspace AI-Einführung für Entwickler
Wenn Sie eine Integration mit einem AI-Coding-Assistenten entwickeln, beginnen Sie mit der auf Ihren Workspace zugeschnittenen Einführung, anstatt das vollständige OpenAPI-Dokument in Ihre Wissensbasis einzufügen.
Authentifizierte GET /api/v1/agents-azumuta.md liefert eine Markdown-Datei für Ihren Workspace (Basis‑URL, Sprachen und API‑Konventionen). Laden Sie sie aus der Einführung der integrierten API-Dokumentation herunter oder fordern Sie diesen Pfad mit Ihrem API-Schlüssel an.
Die maschinenlesbare OpenAPI-Spezifikation ist unter /api/v1/spec.json verfügbar (erfordert ebenfalls Ihren API‑Schlüssel) oder über die Swagger UI in den API-Dokumenten.
MCP für AI-Assistenten (beta)
Beta-Funktion. Der MCP (Model Context Protocol) Server von Azumuta ermöglicht AI-Assistenten, für Ihren Workspace zugelassene REST-Tools aufzurufen. Er befindet sich in beta, kann sich noch weiterentwickeln und ist nur per Opt‑in verfügbar. Um MCP zu aktivieren oder Fragen zu stellen, kontaktieren Sie support@azumuta.com.
Der MCP-Zugriff setzt das Workspace-MCP-Experiment und einen API-Schlüssel mit expliziten Scopes voraus. Verwenden Sie vorzugsweise die Workspace AI-Einführung und die integrierte API-Dokumentation für Endpunktkonventionen; fügen Sie das vollständige OpenAPI‑Dokument nicht in eine gemeinsame Wissensbasis ein.
API aus serverseitigen Integrationen aufrufen
Rufen Sie die Azumuta REST API nur aus serverseitigen Integrationen auf. Bewahren Sie den API‑Schlüssel auf Ihrem Server oder der Integrationsschicht auf – nicht im Browser der Bediener oder in anderem clientseitigen Code.