Using WebLicht from the Commandline

From WebLichtWiki

(Difference between revisions)
Jump to: navigation, search
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
WebLicht web services are implemented as RESTstyle web services: this means, they can be called not only from WebLichts graphical user interface, but also from the commandline.
 
WebLicht web services are implemented as RESTstyle web services: this means, they can be called not only from WebLichts graphical user interface, but also from the commandline.
  
−
On Unix-like systems like Linux or Mac OS X, two CLI tools can be used for this task: wget or curl. In the following, the use of curl is described.
+
However, we strongly recommend you to use [https://weblicht.sfs.uni-tuebingen.de/WaaS/ WaaS(Weblicht as a Service)] instead of sending POST requests to web services directly.
  
−
A generic call of a WebLicht web service with curl looks like this:
+
For further information, please refer to [https://weblicht.sfs.uni-tuebingen.de/WaaS/ WaaS].
−
 
+
−
<code>curl -H 'content-type: text/plain' -d @input.tcf -X POST "http://url-to-webservice-with-parameters" -o output.tcf</code>
+
−
 
+
−
Where input.tcf is the input file and output.tcf is the output file (the file extension doesn't play a role). For some web services, it is necessary to specify additional parameters in the form of GET parameters.
+
−
 
+
−
For example, converting a file with UTF-8 encoded plain text to a TCF file, the whole command looks like this:
+
−
 
+
−
<code>curl -H 'content-type: text/plain' -d @input.tcf -X POST
+
−
"http://weblicht.sfs.uni-tuebingen.de/rws/convert-all/qp?informat=plaintext&language=de&outformat=tcf04" -o output.tcf</code>
+
−
 
+
−
This command will send the data of the file input.tcf to the converter web service, which sends back TCF data. This TCF data is stored in the file output.tcf. In addition, the converter web service needs some parameters (input format, language and output format) which are appended to the URL as GET parameters.
+
−
 
+
−
In a next step, the output of the web service (output.tcf) can be used as input for a tokenizer, for example:
+

Latest revision as of 09:22, 9 October 2014

WebLicht web services are implemented as RESTstyle web services: this means, they can be called not only from WebLichts graphical user interface, but also from the commandline.

However, we strongly recommend you to use WaaS(Weblicht as a Service) instead of sending POST requests to web services directly.

For further information, please refer to WaaS.