Auf Dokumente per Links extern zugreifen

Dokumente können Sie aus agorum core über einen Link auf verschiedene Arten aufrufen:

• Zugriff direkt auf ein im lokalen Netz verfügbares agorum core
  • mit Zugriffsrechten (Authentisierung entweder über SSO mit Kerberos oder zuvor angemeldet in einem Browser)
  • durch Zugriff über ein vorangestelltes Login-Fenster
• Zugriff über das Internet / einen Proxyserver mit fest voreingestelltem Login

Ein Dokument über die agorum core api herunterladen

---

Direktes Herunterladen

Voraussetzungen

• Sie benötigen mindestens Leserechte auf das Objekt.
• Authentisierung ist vorhanden (bereits im Browser in agorum core angemeldet oder angemeldet über Kerberos (Single-Sign-On)).

Der Link lädt das Dokument direkt vom agorum core-Server im Original herunter. Dabei können Sie die ID oder UUID (empfohlen) angeben.

http://agorum-core-serverhttps://agorumdocproxy.agorum.com/api/rest/object/download/[ID oder UUID]

Falls Sie das Dokument im Browser nur anzeigen und nicht herunterladen möchten, führen Sie nachfolgenden Aufruf aus, etwa für Bilder oder PDF-Dateien:

http://agorum-core-serverhttps://agorumdocproxy.agorum.com/api/rest/object/embed/[ID oder UUID]

Als PDF herunterladen

Voraussetzungen

• Sie benötigen mindestens Leserechte auf das Objekt.
• Das Dokument muss die Konvertierung in PDF unterstützen.

Der Link lädt das Dokument direkt vom agorum core-Server im Original herunter und wandelt es in eine PDF-Datei. Dabei können Sie die ID oder UUID (empfohlen) angeben.

Je nach Größe des Dokuments kann die Konvertierung einen Moment dauern, der Aufruf blockiert dann so lange, bis das PDF zur Verfügung steht.

Download

http://agorum-core-serverhttps://agorumdocproxy.agorum.com/api/rest/object/download/[ID oder UUID]/pdf

Im Browser darstellen

http://agorum-core-serverhttps://agorumdocproxy.agorum.com/api/rest/object/embed/[ID oder UUID]/pdf

Zugriff mit vorangestelltem Login-Fenster

---

Ist kein Single-Sign-On vorhanden oder möglich und der Benutzer ist nicht bereits im WebUI von agorum core angemeldet, können Sie agorum core-Links auch über ein Login-Fenster leiten.

Dabei erscheint bei einem unangemeldeten Benutzer der Login-Dialog von agorum core. Erst nach erfolgreicher Anmeldung ruft das System dann den eigentlichen Link auf (etwa den Downloadlink).

Hat der Benutzer sich bereits angemeldet und sind diese Information im Kontext des genutzten Browsers noch bekannt (Cookies), dann führt der Aufruf direkt zum Downloadlink.

Diese Methode funktioniert mit allen direkten agorum core-Links.

Beispiel eines Downloadlinks mit der id=123456

Aus https://agorumdocproxy.agorum.com/api/rest/object/download/123456 wird:

http://agorum-core-server/roiwebui/home_module/?url=%2Fapi%2Frest%2Fobject%2Fdownload%2F123456

Der erste Teil ist der Login-Aufruf mit dem Parameter url. Dort wird der eigentliche Aufruf URL-encoded mitgegeben.

Folgend ein Code-Beispiel, wie ein solcher Aufruf programmatisch erzeugt werden kann:

let downloadUrl = 'https://agorumdocproxy.agorum.com/api/rest/object/download/[ID oder UUID]';
let url = 'http://agorum-core-server/roiwebui/home_module/?url=' + encodeURIComponent(downloadUrl);

Den agorum core client aufrufen

---

Sie können URL-Aufrufe an den agorum core client schicken, sofern er installiert ist.

Sie können etwa ein Dokument, von dem die ID bekannt ist, über das DMS-Laufwerk öffnen:

agorum:open:path:get:<ID eines agorum Objekts>

Parameter	Beschreibung
agorum	Definiert das URL-Schema für den agorum core client. Dadurch wird dieser angesprochen.
open	Definiert die Aktion, die das System ausführt.
path:get	Ruft ein Skript im Client auf, das anhand der ID den Pfad des Laufwerkes ermittelt.
ID	Definiert die ID des Objekts, das das System öffnet.

Auf diese Art können Sie alle möglichen Befehle über den agorum core client ausführen.

Externer Zugriff über das Internet

---

Sie können einen vorgeschalteten Web-Proxy verwenden, um Links zum Herunterladen ohne vorherige Anmeldung anzubieten, etwa wenn Dokumente aus agorum core direkt auf einer Website verlinkt werden sollen und damit öffentlich zugänglich sind. Durch den Proxy stellen Sie den agorum core-Server nicht direkt ins Internet. Dabei findet keine Authentisierung statt und der Zugriff erfolgt lediglich über einen technischen Benutzer im Hintergrund.

Richten Sie einen Web-Proxy so ein, dass er nach außen ins Internet verfügbar ist. Aufrufe von außen werden von dem Proxy so verarbeitet, dass sie nach intern über einen Proxy zu den oben beschrieben Links führen. Bei der Verbindung wird im Proxy dabei automatisch ein Basic-Auth-String mitgegeben, sodass eine interne Authentisierung zu agorum core gegeben ist. Die Authentisierung läuft vollständig im Hintergrund.

Beispiel für Apache mod_proxy

<VirtualHost *:80>
  ...

  RewriteEngine On

  ProxyPass /agorum-download/ http://interne-agorum-ip/api/object/download/
  ProxyPassReverse /agorum-download/ http://interne-agorum-ip/api/object/download/

  RequestHeader set Authorization "Basic XJHVDJVXJHGVXHGVXHGVXHGXVHGV="
</VirtualHost>

Wird auf dem Webserver die URL http://ihr-webproxy-server/agorum-download/[ID oder UUID] aufgerufen, so findet ein interner Proxy-Aufruf der internen agorum-core-Download-URL statt.

Dabei wird immer ein Request-Header mit Benutzername und Kennwort eines technischen agorum core-Benutzers mitgeschickt, codiert als BASE64. Dieser Header ist lediglich intern sichtbar und wird nie nach außen gegeben, der Aufrufer bekommt davon nichts mit.

Durch diesen gezielten Proxy wird der Aufruf ausschließlich auf den Download-Teil der agorum core-API beschränkt und intern ausschließlich mit den Rechten des technischen Benutzers gearbeitet.

Weiterführende Beispiele

---

Ein Preview-Bild laden

Folgendes Beispiel lädt die erste Vorschau-Seite eines Dokuments als Bild.

1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann API-Dokumentation.
   
   Ergebnis: Die API-Dokumentation öffnet sich.
2. Klicken Sie auf die Überschrift Preview.json.
   
   Ergebnis: Ein Unterbereich öffnet sich.
3. Klicken Sie auf download a preview image.
   
   Ergebnis: Ein weiterer Unterbereich öffnet sich.
4. Testen und erstellen Sie die Links.
   
   Beispiel

   http://ihr-agorum-core-serverhttps://agorumdocproxy.agorum.com/api/rest/object/preview/[id oder UUID].jpg?page=1&size=120

   Zeigt ein Vorschau-Bild (Thumbnail) des Dokuments mit der angegebenen ID mit einer maximalen Größe (Breite oder Höhe) von 120 Pixeln an.
   
   • Das Original-Bild lädt in voller Größe herunter, wenn Sie keine size angeben.
   • Die Angabe page bestimmt, welche Seite des Dokuments das System lädt.
   • Der Aufruf funktioniert nur bei Aufrufen, für die auch eine Vorschau erzeugt werden kann.
   • Sie können diesen Aufruf wie alle anderen URL-Aufrufe mit den in dieser Dokumentation genannten Authentisierungs-Verfahren kombinieren.

Ein aguila-Widget aufrufen

Sie können aguila-Widgets über eine URL direkt aufrufen. Zusammen mit der Konfiguration von aguila-Widgets kann hier jede beliebige Art von Konfiguration erfolgen.