}

/v1/document/thumbnails

https://api.reporting.cloud/v1/document/thumbnails

Creates and returns thumbnail images of documents.

Document Quota

This method counts against the document quota. For each successful request, the quota count is increased by 1.

Authorization

This endpoint requires a "ReportingCloud-APIKey" or a "Basic" user authorization to access the user acount, data and templates. Only one of these two methods are required.

ReportingCloud-APIKey
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

An API Key needs to be generated using the portal or /v1/account/apikey endpoint. The authorization method and a space i.e. "ReportingCloud-APIKey " is then put before the actual API Key string.

Sample:

Authorization: ReportingCloud-APIKey oMDM4MrAqL9QEOpyzupnQW5NjvCNtvE5cVDaaLqxI

Basic
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

The username and password are combined into a string separated by a colon, e.g.: username:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string.

Sample:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l


Request Parameters

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

Request Payload

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

Success Response

Return Value Description

200 (OK)

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

Return Value Description

403 (Forbidden)

A 403 (Forbidden) is returned, if the user is not authorized or the document quota is exceeded.

400 (Bad Request)

A 400 (Bad Request) is returned, if the document is not valid or doesn't exist in the request payload.

Sample Requests

Request:

Results:

Request:

Results: