Document

The endpoints below /v1/document create documents and page images. They merge a template with JSON data, append several documents to one, convert a document to another format, replace text in a template, render the pages of a document as images and return an encrypted name under which a template of the template storage can be shown in the viewer widget of ReportingCloud. Templates and documents travel in the request body as Base64 strings, and the created documents come back the same way. Merge and find and replace take either a template in the request or the templateName of a stored template.

Every method except share counts against the document quota, one per successful request whatever the number of documents it returns (a test run of convert or append on a trial account is not counted), and its processing time is limited to 60 seconds. The .NET SDK calls all six with MergeDocument, AppendDocument, ConvertDocument, FindAndReplaceDocument, GetDocumentThumbnails and ShareDocument. The PHP SDK calls five of them with mergeDocument, appendDocument, convertDocument, findAndReplaceDocument and getDocumentThumbnails, and has no method for share. The Java SDK covers merge, append, convert and find and replace with mergeDocument, appendDocuments, convertDocument and findAndReplace, and the Ruby SDK with merge_document, append_documents, convert_document and find_and_replace. Mail Merge explains merging, and Document Processing the other tasks.

Methods