Access via Converter API
Basics
Access to the Converter Api is being authenticated via HTTP-Basic authentication.
Authentication is needed for each and every access to the Api.
To set the correct HTTP-Headers for the HTTP-Basic authentication in curl, use the -- user name:password option.
Apply to Gerrit Imsieke of le-tex publishing servies GmbH for access keys.
API documentation
| URL | Verb | Parameters | Description | Returns |
|---|---|---|---|---|
| https://transpect.le-tex.de/api/upload_file | POST | input_file: file, type: string add_params: string |
Upload 'input_file' and start conversion of type 'type'. Multipart POST request required. With the optional 'add_params'-parameter additional parameters are passed on to the conversion-process. They must be declared as key-value pairs in the form: 'key=value' and separated by a semicolon ';'. |
(JSON) conversion_type: string status: (uploaded|running|success|failure) callback_uri: URL for retrieval of further status information for this conversion |
| https://transpect.le-tex.de/api/get_status | GET | input_file: string, type: string |
sends status information for specific conversion job |
(JSON) status: (uploaded|running|success|failure) message: verbose status information of conversion process result_list_uri: (only for status 'success') uri for retrieval of output file list for this conversion delete_uri: uri for deleting all data that belongs to this conversion |
| https://transpect.le-tex.de/api/get_result_list | GET | input_file: string, type: string |
sends list of output files for the specified conversion including information for postprocessing options |
(JSON) files: hash { <filename>: information about possible post-processing options and download URL } postproc_uri: example url for postprocessing. 'action' is wildcard for name of post-processing action. 'filename1 filename2' is wildcard for space-separated list of files to process |
| https://transpect.le-tex.de/api/download_result | GET | input_file: string, type: string file: string |
Sends specified output-file of conversion as binary data | (File Download) |
| https://transpect.le-tex.de/api/start_action | GET | input_file: string, type: string action_type: string files: string (space-separated list of filenames) |
Starts post-processing operation 'action_type' for files. |
(JSON) status: verbose status information |
| https://transpect.le-tex.de/api/get_all_conversions | GET | type: string | sends list of previously uploaded files including basic status information |
(JSON) files: hash { <filename>: hash { status: (uploaded|running|success|failure) last_changed: Timestamp callback_uri: uri for retrieval of extended status information result_list_uri: uri for retrieval of output file list for this conversion delete_uri: uri for deleting all data that belongs to this conversion } } |
| https://transpect.le-tex.de/api/delete | GET | input_file: string, type: string |
Deletes data of specified conversion from server | (JSON) status: status of deletion process |
