Difference between revisions of "Example Clients"

Revision as of 12:14, 21 January 2016

To call a TextServer service from a client program running on your side, this client needs to send the appropriate request in the right format.

The request is a standard HTTP POST request with a multiform part containing the same information you would submit via the web interface.

Below you'll find a list of example client programs in different programming languages.

The same code can be used to access any TextServer service with small variations:

• Simply change the service name in the URL to access a different service. You can find out the service name at the top of the "Execute" form of your subscribed services.
• Replace the parameters in the example client with the parametes that the called service requires. Rules are simple:
  • Language identification service does not require a "language" parameter, but the other services do.
  • All services require a "interactive" parameter stating whether the job is interactive or batch.
  • All services require either a "text_input" parameter (for interactive jobs) or a "input_file" parameter (for batch jobs).
  • You can find out the name of any other specific parameters for a service in the "Execute" form of your subscribed services.

Example Clients for Interactive Jobs

Below there is a list of example of how to send an interactive request to a service named SERVICENAME using different programming languages. You'll need to replace SERVICENAME with the actual name of the desired service, and adapt the list of parameters in the request to those expected by the service.

• Python
• Java
• Perl
• PHP
• bash (using curl)

Example Clients for Batch Jobs

Below there is a list of example of how to send a batch request to a service named SERVICENAME using different programming languages. You'll need to replace SERVICENAME with the actual name of the desired service, and adapt the list of parameters in the multipart form to those expected by the service.

These clients send the request, then poll the server until the job is finished, and then they retrieve the results.

However, this doesn't have to be like this, and can be done to your convenience (e.g. have an independent cron job that polls for all sent requests once every hour, add a trigger in your mail that will launch the retrieval when the "job completed" mail is received, etc.)

• Python
• Java
• Perl
• PHP
• bash (using curl)

Retrieving Results of Batch Requests

When the user submits a batch request, TextServer responds with a Token ID that will identify the job and allow retrieval of the results when it is done.

The user can retrieve the results manually in the web page, or programmatically from a remote client. Example remote clients to retrieve batch requests results are provided below.

TextServer will notify the user via email when the job is finished. Alteratively, the user can poll TextServer periodically to find out whether job results are ready.

When the user attempts to retrieve the results of an unfinished job, TextServer will respond with a HTTP 503 error message (Service Unavailable) containing the TextServer error code TS-125 (job not finished) in the message body.

• Python
• Java
• Perl
• PHP
• bash (using curl)