Generate Document Pages Preview

Introduction

This REST API provides an ability to generate document pages of image representations. There are several ways to specify page numbers needed for preview:

  • Provide exact page numbers via Pages collection;
  • Specify pages range start/end page numbers. There is also an ability to get only even/odd pages from the specified page range by setting RangeMode property.

For protected documents, it is also required to provide a password. The following properties of preview may be customized:

NameDescriptionComment
FilePathThe file path in the storageRequired property
StorageNameStorage nameCould be omitted for default storage
VersionIdFile version IdUseful for storages that support file versioning
PasswordThe password to open fileShould be specified only for password-protected documents
PagesCollection of page numbers to use in a Join operationThe first page should have number 1
StartPageNumberStart page numberIgnored if Pages collection is not empty
EndPageNumberEnd page numberIgnored if Pages collection is not empty
RangeModePage range mode: Even, Odd, All. The default value is AllIgnored if Pages collection is not empty
WidthImage width in pixelsOptional
HeightImage height in pixelsOptional
FormatImage format - JPG, PNG, BMPThe default value is JPG
OutputPathPath format to resultant imagesRequired

Resource URI


HTTP POST ~/preview

Swagger UI lets you call this REST API directly from the browser.

cURL Example

* First get JSON Web Token
* Please get your App Key and App SID from https://dashboard.groupdocs.cloud/#/apps. Kindly place App Key in "client_secret" and App SID in "client_id" argument.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=xxxx&client_secret=xxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

* cURL example to join pages from several documents into one document
curl -v "https://api.groupdocs.cloud/v1.0/merger/preview" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer
<jwt token>"
-d "{
    'FileInfo': { 'FilePath': 'WordProcessing/four-pages.docx' },
  'OutputPath': '/Output/preview-page',
  'Pages': [1, 3],
  Format: 'Png'
 }"


*Response will contain storage path to resultant documents
{
  'documents': [
    {
      'path': '\Output\page_1.png'
    },
    {
      'path': '\preview\page_3.png'
    }
  ]
}

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of makingRequests and handlingResponses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of GroupDocs.Merger Cloud SDKs along with working examples, to get you started in no time. Please check the article to learn how to add an SDK to your project.

Generate Document Pages Preview