DocuWare Aura lässt sich auch außerhalb der Benutzeroberfläche von DocuWare Cloud einsetzen. Über die Aura API senden Anwendungen Fragen an DocuWare Aura und nutzen die Antworten und Quelldokumente in ihren eigenen Anwendungen, Portalen, Automatisierungsprozessen und KI-Assistenten.
Es gibt zwei grundlegende Wege, die API zu nutzen.
Sie lassen DocuWare Aura die Frage beantworten.
Oder Sie nutzen Aura nur, um die relevanten Dokumente abzurufen, und überlassen die Auswertung einer anderen Anwendung oder einem KI-Agenten. Diese zweite Möglichkeit eignet sich, wenn DocuWare eines von mehreren Systemen ist, mit denen ein externer Agent arbeiten muss.
Sie nutzen die Aura API über die DocuWare Cloud URL Ihrer Organisation. API-Anfragen sind organisationsspezifisch und benötigen die UUID der Organisation (org_id). Alle Endpunkte verwenden zur Authentifizierung ein JWT-Bearer-Token. Das Token wird vom DocuWare Identity Service (IDS) ausgestellt. Die Aura API prüft das Token, stellt es aber nicht aus.
Die vollständige API-Definition finden Sie in Ihrer DocuWare Cloud. Ersetzen Sie „YourCloudDomain“ durch Ihre tatsächliche Cloud Domain:
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Einsatzmöglichkeiten der Aura API
Die API ist immer dann hilfreich, wenn eine Anwendung DocuWare Dokumente als Teil einer anderen Benutzererfahrung oder eines anderen Geschäftsprozesses benötigt.
Typische Beispiele:
Ergänzen Sie ein ERP, CRM, Beschaffungsportal oder eine andere Geschäftsanwendung um Fragen zu Dokumenten.
Beantworten Sie Fragen aus Verträgen, Vereinbarungen oder anderen Dokumenten, ohne die Benutzer in die DocuWare Oberfläche zu leiten.
Geben Sie einem externen Agenten Zugriff auf das verwaltete Dokumentenwissen aus DocuWare, während er es mit Informationen aus anderen Systemen kombiniert.
Nutzen Sie DocuWare als eine Wissensquelle zusammen mit Systemen wie SharePoint, CRM, ERP oder Serviceplattformen.
DocuWare bleibt der Dokumentenspeicher. Die API liefert die intelligente Ebene, die eine externe Anwendung nutzen kann, ohne die Dokumente in ein anderes System kopieren zu müssen. Der Zugriff auf die Dokumente richtet sich weiterhin nach den Berechtigungen des authentifizierten Kontexts.
Die passende API wählen
Die wichtigste Entscheidung ist, ob DocuWare Aura die Antwort generieren oder nur die relevanten Dokumente abrufen soll.
Aura Query API
Verwenden Sie diese, wenn DocuWare Aura die Frage verstehen, die relevanten Dokumente finden und die Antwort generieren soll. Die Antwort enthält außerdem die Quelldokumente, die für sie verwendet wurden.
Retrieval API
Verwenden Sie diese, wenn eine andere Anwendung oder ein KI-Modell die abschließende Auswertung übernehmen soll. Die Retrieval API findet relevante, zugängliche Dokumente und gibt die Quellen zurück.
Verbindung mit der API herstellen
Die vollständige API-Dokumentation mit den genauen Endpunkten, Parametern, Schemas, Anfragebeispielen und Codebeispielen finden Sie direkt in der Swagger-Dokumentation Ihrer DocuWare Cloud:
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/ Wichtige API-Endpunkte
Aura eine Frage stellen
Verwenden Sie diesen Endpunkt für dialogbasierte Abfragen. Optional geben Sie Archive oder Dokumente an und setzen Konversationen über eine session_id fort.
POST /api/v3/{org_id}/query Einzelabfrage ohne Konversationsverlauf
Gibt eine Antwort auf die aktuelle Frage zurück, ohne eine Sitzung zu verwenden.
POST /api/v2/{org_id}/single-query Streaming-Antworten
Überträgt die Antwort per Server-Sent Events (SSE). Das eignet sich für Chat-Oberflächen.
POST /api/v3/{org_id}/query/stream Nur Dokumentenabruf
Ruft relevante DocuWare Dokumente ab, ohne eine Volltextantwort zu generieren.
POST /api/v2/{org_id}/retrieval-query Die genauen Request-Bodies, verfügbaren Parameter, Antwortformate und einsatzbereiten Codebeispiele finden Sie direkt in der Swagger-Dokumentation Ihrer DocuWare Cloud.
Weitere API-Endpunkte
Die Aura API enthält weitere Endpunkte für Konfiguration, den Status der Dokumentenverarbeitung, Konversationen, Feedback und verwandte Vorgänge.
Die Konversations-Endpunkte listen zum Beispiel die gespeicherten Konversationen eines Benutzers auf. Sie rufen eine Konversation mit ihrem vollständigen Nachrichtenverlauf ab, benennen sie um, heften sie an oder löschen sie. Diese Endpunkte sind hilfreich, wenn Sie eine vollständig eigene Chat-Oberfläche aufbauen. Die meisten Integrationen benötigen jedoch nur die oben beschriebenen Query- oder Retrieval-Endpunkte.
Die vollständige Liste der Endpunkte, die Anfrage- und Antwortschemas sowie Beispiele finden Sie in der Swagger-Dokumentation.
Einen KI-Agenten mit DocuWare verbinden
Sie können DocuWare als Werkzeug für Ihren externen KI-Agenten nutzen. Der Agent durchsucht DocuWare Dokumente und nutzt die Ergebnisse zusammen mit Informationen aus anderen Systemen wie einem ERP oder CRM.
Erste Schritte
Öffnen Sie die Swagger-Dokumentation in Ihrer DocuWare Cloud:
https://YourCloudDomain.docuware.cloud/DocuWare/aura/docs#/Übergeben Sie Ihrem Agenten die API-Definition
Wenn Ihr Agent oder Ihre KI-Plattform den Import von OpenAPI/Swagger unterstützt, können Sie die Swagger-Spezifikation direkt bereitstellen. Die Plattform erstellt daraus die verfügbaren API-Werkzeuge.
Authentifizierung einrichten
Der Agent benötigt ein gültiges DocuWare JWT, um die API aufzurufen.
Wählen Sie die benötigte API
Query API: Stellen Sie Aura Fragen zu Dokumenten.
Retrieval API: Rufen Sie relevante Dokumente für Ihr eigenes KI-Modell oder Ihren eigenen Agenten ab.
Lassen Sie den Agenten DocuWare bei Bedarf nutzen.
Der Agent kann zum Beispiel Rechnungsdaten aus einem ERP abrufen, den zugehörigen Vertrag in DocuWare suchen und beide vergleichen, bevor er eine Antwort gibt.
Die Swagger-Dokumentation enthält die genauen Endpunkte, Parameter, Anfrage- und Antwortschemas sowie Codebeispiele, die Sie für die Integration benötigen.
Kurz gesagt: Wenn Ihre Agentenplattform OpenAPI unterstützt, stellen Sie ihr die DocuWare Swagger-/OpenAPI-Definition bereit, richten Sie die JWT-Authentifizierung ein und stellen Sie die benötigten DocuWare Endpunkte als Werkzeuge bereit.