Azumutas REST-API
Hinweis: Dies ist ein technisch sehr anspruchsvoller Artikel. Daher empfehlen wir, Ihre IT‑Abteilung beim Lesen einzubeziehen. Bei Fragen oder Anliegen kontaktieren Sie uns bitte unter 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‑kodierte Antworten zurückgegeben.
Authentifizierung
Die Azumuta‑API verwendet API‑Schlüssel zur Authentifizierung von Anfragen. Senden Sie den Schlüssel im X-API-Key Anforderungsheader (empfohlen). Sie können alternativ auch den Query‑Parameter apiKey verwenden.
Erstellen und verwalten Sie Schlüssel unter Management → Devices → API. Siehe API‑Schlüssel erstellen und verwalten.
Alle API‑Anfragen müssen über HTTPS erfolgen. Aufrufe über reines HTTP schlagen fehl. API‑Anfragen ohne Authentifizierung schlagen ebenfalls fehl.
Hinweis: Ihre API‑Schlüssel sind streng vertraulich und dürfen niemals mit Personen außerhalb Ihres Unternehmens geteilt werden. Sie dürfen auch niemals im Browser‑Clientcode erscheinen.
Zugriff auf die API‑Dokumentation
Die Azumuta REST‑API ist in der integrierten API‑Dokumentation innerhalb der Anwendung beschrieben:
- Klicken Sie auf das Fragezeichen oben rechts auf Ihrem Bildschirm (Help).
- Klicken Sie auf API docs.
Das öffnet die interaktive Referenz unter /docs/api in der Azumuta Platform. 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 Platform sehen.
Workspace AI‑Primer für Entwickler
Wenn Sie eine Integration mit einem AI‑Coding‑Assistenten entwickeln, beginnen Sie mit der auf den Workspace zugeschnittenen Einführung, anstatt das vollständige OpenAPI‑Dokument in Ihre Wissensbasis einzufügen.
Authentifizierter 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 der API‑Dokumentation.
MCP für AI‑Assistenten (Beta)
Beta feature. Azumuta's MCP (Model Context Protocol) Server ermöglicht AI‑Assistenten das Aufrufen genehmigter REST‑Tools für Ihren Workspace. Es ist als Beta gekennzeichnet, 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 Zugriff auf MCP erfordert das Workspace‑MCP‑Experiment und einen API‑Schlüssel mit expliziten Scopes. Nutzen Sie vorzugsweise die Workspace AI‑Einführung und die integrierte API‑Dokumentation für Konventionen zu Endpunkten; fügen Sie das vollständige OpenAPI‑Dokument nicht in eine gemeinsame Wissensbasis ein.
Aufruf der API aus serverseitigen Integrationen
Rufen Sie die Azumuta REST‑API ausschließlich aus serverseitigen Integrationen auf. Bewahren Sie den API‑Schlüssel auf Ihrem Server oder in der Integrationsschicht auf — nicht in Operator‑Browsern oder anderem clientseitigen Code.