Mit der JobRouter-REST-API erhalten Sie eine Möglichkeit aus externen Anwendungen mit JobRouter zu interagieren. Sie können z.B. Vorgänge starten, Dokumente archivieren und auf die Inhalte von Datenbanktabellen zugreifen.
Die API basiert auf dem HTTP-Protokoll. Dabei werden die HTTP-Methoden GET, POST, PUT, PATCH, DELETE und OPTIONS verwendet, um auf bereitgestellte Ressourcen per definierten URLs zuzugreifen. Erfolgreiche Anfragen oder Fehlerfälle werden durch Standard-HTTP-Statuscodes in den Anworten von JobRouter gekennzeichnet. Die Antworten sind im JSON-Format oder in binärer Form.
Die API ist ab JobRouter Version 3.6.1 vorhanden und wird kontinuierlich weiterentwickelt. Die aktuelle Version (v2) wurde mit JobRouter 3.8 offiziell freigegeben.
Voraussetzungen
•Sie können die REST-API in allen JobRouter-Lizenzpaketen ohne zusätzliche Lizenz benutzen. Für einige Ressourcen benötigen Sie allerdings eine entsprechende Lizenz für das jeweilige Modul.
•Alle HTTP-Methoden sind in der Konfiguration der Windows-Internetinformationsdienste aktiviert (siehe Installationshandbuch).
•Die REST-API kann nur nach einer erfolgreichen Authentifizierung verwendet werden.
