HTTP REST-Client-Schnittstelle
RaptorXML+XBRL Server nimmt über HTTP (oder HTTPS) gesendete Aufträge an. Die Übertragung der Auftragsbeschreibung sowie der Ergebnis erfolgt im JSON-Format. Im unten gezeigten Diagramm sehen Sie eine Beschreibung des Ablaufs.
Sicherheitsfragen im Zusammenhang mit der HTTP REST-SchnittstelleStandardmäßig können Ergebnisdokumente über die HTTP REST-Schnittstelle in jeden durch den Client angegebenen Ordner (auf den über das HTTP-Protokoll Zugriff besteht) geschrieben werden. Beim Konfigurieren von RaptorXML+XBRL Server sollte dieser Sicherheitsaspekt daher berücksichtigt werden.
Falls die Sicherheit eventuell gefährdet sein könnte oder jemand über die Schnittstelle unbefugten Zugriff erhalten könnte, kann der Server so konfiguriert werden, dass Ergebnisdokumente in ein eigenes Ausgabeverzeichnis auf dem Server selbst geschrieben werden. Dies geschieht durch Setzen der Option server.unrestricted-filesystem-access der Server-Konfigurationsdatei auf false. Wenn der Zugriff auf diese Weise eingeschränkt ist, kann der Client Ergebnisdokumente aus dem dafür vorgesehenen Ausgabeverzeichnis mit GET Requests herunterladen. Alternativ dazu kann ein Administrator die Ergebnisdokumentdateien vom Server in den Zielordner kopieren/laden. |
In diesem Abschnitt
Bevor Sie einen Client Request senden, muss RaptorXML+XBRL Server gestartet und ordnungsgemäß konfiguriert werden. Eine Beschreibung dazu finden Sie im Abschnitt Einrichten des Servers. Eine Beschreibung dazu, wie man Client Requests sendet, finden Sie im Abschnitt Client Requests. Im Abschnitt C#-Beispiel für die REST API finden Sie eine Beschreibung der mit Ihrem RaptorXML+XBRL Server-Paket installierten REST API-Beispieldatei.