Endpoint /documentprocessing/document/thumbnails

POST https://example.com/documentprocessing/document/thumbnails

POST

Creates and returns thumbnail images of documents.

Examples

The following sample creates thumbnail images of a given document for page 1 and 2.

HTTP

# Request:
curl --location --request POST 'https://trial.dsserver.io/documentprocessing/document/thumbnails?imageFormat=PNG' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer GphAd1R0npJM9OuX2y9mUa4cfqPMOg6p' \
    --data-raw '"eAUBAA4AAAAAAAAAAAAOAAAAVFhUZXh0Q29udHJvbDEAXAEAAA[..]="'

# Result:
[
    "JVBERi0xLjQNJeLjz9MNMSAwIG9iago8PAovVH[..]",
    "JVBERi0xLjQNJeLjz9MNMSAwIG9iago8PAovVH[..]"
]

Authorization

This endpoint supports the OAuth authorization method:

OAuth

DS Server implements OAuth as the authorization method. Two flows are supported:

Authorization Code
Client Credentials

In order to use the Client Credentials flow, this method must be explicitly enabled in the admin portal of DS Server.

In both cases, a valid access token returned from the OAuth endpoints must be passed in a Bearer Authorization Header or as a Query Parameter.

Authorization Header

Header Field	Description
Authorization	A Bearer authorization header (also called token authentication) contains the OAuth access token. The authorization method and a space i.e. "Bearer " is then put before your valid access token. For example: Authorization: Bearer 4796E23054E64BC773CACBCAF24AD179DE9A3

Query Parameter

Query Parameter	Description
access_token	The access token is passed directly in the endpoint URL as a query string. For example: ?access_token=4796E23054E64BC773CACBCAF24AD179DE9A3

Request Parameters

Name	Type	Value	Optional
zoomFactor	Integer	An Integer value between 1 and 400 to set the percentage zoom factor of the created thumbnail images. Default value is 100.	yes
fromPage	Integer	An Integer value that specifies the first page. By default the first page is selected. Default value is 1.	yes
toPage	Integer	An Integer value that specifies the last page. By default the last page is selected. Default value is 0.	yes
imageFormat	String	A string value that defines the image format of the returned thumbnails. Possible values are "PNG", "JPG", "GIF" and "BMP". Default value is "PNG".	yes

Request Payload

Type	Value
String	A document encoded as a Base64 string. Supported formats are DOC, DOCX, PDF, TX, XLSX, RTF and HTML.

Success Response

Status	Description
200	On success, the HTTP status code in the response header is 200 (OK). The response body a string array of Base64 encoded images in the selected format.

Error Response

Status	Description
401	A 401 (Unauthorized) is returned, if the user is not authorized.
400	A 400 (Bad Request) is returned, if DS Server is not licensed or the license is invalid.
400	A 400 (Bad Request) is returned, if the image format is not supported.
400	A 400 (Bad Request) is returned, if no document has been found in the body.
400	A 400 (Bad Request) is returned, if the given page numbers are invalid.
400	A 400 (Bad Request) is returned, if the uploaded document is not valid.