Azumutas REST-API
Hinweis: Dieser Artikel ist technisch, daher empfehlen wir, eine Person mit der passenden technischen Expertise hinzuzuziehen. Wenn Sie Fragen haben, kontaktieren Sie uns unter support@azumuta.com.
Unsere REST API verwendet standardmäßige HTTP-Antwortcodes und HTTP-Methoden. 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. Sie haben zwei Optionen:
Header (empfohlen)
Senden Sie den Schlüssel im X-API-Key Request-Header.
Parameter
Verwenden Sie den Query-Parameter apiKey.
Erstellen und verwalten Sie Schlüssel unter Management → Devices → API. Siehe Create and manage API keys.
Alle API-Anfragen müssen über HTTPS erfolgen. Aufrufe über plain HTTP schlagen fehl. API-Anfragen ohne Authentifizierung schlagen ebenfalls fehl.
Hinweis: Ihre API-Schlüssel sind sensible Informationen, die niemals mit Personen außerhalb Ihres Unternehmens geteilt werden dürfen und niemals in Browser-Client-Code erscheinen dürfen.
Zugriff auf die API-Dokumentation
Die Azumuta REST API ist in den API-Dokumenten innerhalb der Anwendung dokumentiert:
- Klicken Sie auf das Fragezeichen oben rechts auf Ihrem Bildschirm (Help).
- Klicken Sie auf API docs.
Dadurch wird das interaktive Referenzhandbuch unter /docs/api in der Azumuta platform geöffnet. 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.
Authentifizierte GET /api/v1/agents-azumuta.md liefert eine Markdown-Datei für Ihren Workspace, die Basis-URL, Sprachen und API-Konventionen enthält. Laden Sie sie über die Einleitung der API-Dokumentation in der App herunter oder fordern Sie diesen Pfad mit Ihrem API-Schlüssel an.
Die maschinenlesbare OpenAPI-Spezifikation ist unter /api/v1/spec.json verfügbar und erfordert ebenfalls Ihren API-Schlüssel, alternativ über die Swagger UI in den API-Dokumenten.
MCP für AI-Assistenten (BETA)
BETA: Azumuta MCP befindet sich derzeit in der Beta-Phase und kann sich noch weiterentwickeln. Es ist nur auf Opt-in-Basis verfügbar. Um an der Beta teilzunehmen oder Fragen zu stellen, kontaktieren Sie support@azumuta.com.
Model Context Protocol (MCP) ermöglicht Ihrem bevorzugten AI-Assistenten, erlaubte Workspace-Daten über ausgewählte, schreibgeschützte Tools abzurufen. Es stellt nicht jede REST-Operation offen. Folgen Sie Connect your AI assistant to Azumuta für die Einrichtung, und sehen Sie Use Azumuta MCP für Beispiele und Einschränkungen.
API aus serverseitigen Integrationen aufrufen
Rufen Sie die Azumuta REST API nur aus serverseitigen Integrationen auf. Verwahren Sie den API-Schlüssel auf Ihrem Server oder in Ihrer Integrationsschicht – nicht in Browsern von Bedienenden oder in anderem clientseitigen Code.