Server APIs; HTTP REST, COM/.NET, Java
In RaptorXML+XBRL Server ist eine HTTP REST-Schnittstelle definiert, über die Clients Aufträge an den Server weitergeben können. Clients können die HTTP REST-Schnittstelle entweder direkt oder über die oberste Ebene der COM/.NET- und Java Server API aufrufen. Diese APIs bieten einfach zu verwendende COM/.NET- und Java-Klassen zur Verwaltung der Erstellung und Absendung der HTTP REST Requests.
Es gibt drei Server APIs, mit deren Hilfe über die HTTP REST-Schnittstelle mit RaptorXML kommuniziert werden kann (siehe auch Abbildung oben).
•HTTP REST-Client-Schnittstelle
| Anmerkung: | Die Server APIs bieten ähnliche Funktionalitäten wie die Befehlszeilenschnittstelle (CLI). Dazu gehören die Validierung und Transformation von Dokumenten. Wenn Sie komplexere Funktionalitäten wie z.B. Auslesen, Extrahieren und Analysieren von Daten verwenden möchten, sollten Sie die Prozessor APIs verwenden. Über die Prozessor APIs stehen Ihnen zusätzliche Informationen wie z.B. die Anzahl der Elemente, deren Position im Dokument und der Zugriff auf und die Bearbeitung von komplexen XBRL-Daten zur Verfügung. |
Verwendung
RaptorXML+XBRL Server sollte auf einem Rechner installiert werden, auf den Clients über das lokale Netzwerk Zugriff haben. Nachdem der RaptorXML+XBRL Server-Dienst gestartet wurde, können sich Clients mit dem Server verbinden und Befehle an diesen senden. Die folgenden Zugriffsmethoden werden als Server APIs bezeichnet, weil sie eine Methode bieten, mit einem entfernten RaptorXML Server zu kommunizieren.
•HTTP REST-Client-Schnittstelle: Die Client Requests erfolgen, wie im Abschnitt HTTP REST-Client-Schnittstelle beschrieben, im JSON-Format. Jedem Request wird auf dem Server ein Auftragsverzeichnis, in dem Ausgabedateien gespeichert werden, zugewiesen. Der Server antwortet dem Client mit allen auftragsrelevanten Informationen.
•COM/.NET API und Java API: Applikationen und Skripts in COM/.NET-Prgrammiersprachen und Java-Applikationen verwenden Objekte der RaptorXML Server API, um Funktionalitäten von RaptorXML+XBRL Server aufzurufen. Die RaptorXML Server API erstellt die entsprechenden HTTP REST Requests für den Client. Nähere Informationen dazu finden Sie in den Unterabschnitten dazu.
Lizenzierung
RaptorXML+XBRL Server wird auf dem Rechner, auf dem er installiert ist, lizenziert. Die Verbindungen zu RaptorXML+XBRL Server erfolgen über HTTP.