|
Endpoints |
Scroll |
Here is a list of endpoints available in the Web API. The endpoints can be enables or disabled (see Web API Configuration section for more details).
http(s)://server_name:port_number/theservice/v0001/soapun - for basic credentials, buffered data transfer
http(s)://server_name:port_number/theservice/v0001/soapwin - for windows credentials, buffered data transfer
WSDL (metadata endpoint):
http(s)://server_name:port_number/theservice/v0001?singlewsdl
MEX (metadata exchange endpoint):
http(s)://server_name:port_number/theservice/v0001/mexhttp
http(s)://server_name:port_number/theservice/v0001/restun - for basic credentials, buffered data transfer
http(s)://server_name:port_number/theservice/v0001/restwin - for windows credentials, buffered data transfer
http(s)://server_name:port_number/theservice/v0001/restun-streamed - for basic credentials, streamed/chunked data transfer
JSON/XML Help Page (use any link below):
http(s)://server_name:port_number/theservice/v0001/restun/help
http(s)://server_name:port_number/theservice/v0001/restwin/help
Sample Json/Xml help page
|
OpenAPI/Swagger Definition & Postman Collection
For Web API REST endpoint, we are providing the following documents: -OpenAPI definition (formerly known as Swagger) version 3.0; -Postman Collection version 2.1;
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs. The OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.
For more details about OpenAPI (Swagger) please refer to: https://swagger.io/.
Postman Collection is a collection of pre-built requests. You can import the provided Therefore Web API collection into Postman (http://postman.com). For the instructions please see https://kb.datamotion.com/?ht_kb=postman-instructions-for-exporting-and-importing#how-to-import-a-collection-into-postman.
|
Streamed JSON endpoint to download big files
There is a streamed endpoint available in Therefore™ Web API. The difference from the other endpoints is that the methods of this endpoint return the HTTP response as Transfer-Encoding: chunked.
Methods on the streamed (chunked) endpoint consumes less memory on both server and client side and MUST be used to retrieve big or huge files.
See more details about chunked transfer encoding here Transfer-Encoding and here Wiki: Chunked transfer encoding.
See more details about the methods of the streamed endpoint below. The same methods are available on the normal (buffered) endpoints.
- GetConvertedDocStreamsRaw (HTTP POST);
- GetDocumentStreamRaw (HTTP POST);
- GetDocumentStreamFile (HTTP GET);
- GetUploadedEFormFile (HTTP GET).
Streamed (chunked) endpoint URL template:
http(s)://server_name:port_number/theservice/v0001/restun-streamed - for basic credentials.
Sample responses of the GetDocumentStreamRaw Web API method executed on buffered (left side) and streamed (right side) endpoints.
Notice Transfer-Encoding HTTP header on the streamed endpoint. It has value "chunked".
Auto-generated help page for the endpoint:
Endpoint URL can be found in Windows Event Viewer after (re)starting Therefore™ XML Web Service:
