Preview Presentation
Purpose
To open a presentation in preview or read-only mode in Zoho Show.
HTTP Request URL
https://{api.office-integrator_domain}/show/officeapi/v1/presentation
Request Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
apikey | 423s***** | Uniquely identifies the web application in which the Show editor is integrated. |
document or url | File or String | Method of providing the input file depending on its location. document - if the input file is from your local drive or desktop. url - if the input file is from a publicly accessible Web URL. |
Optional Parameters | ||
language | String | Enables the editor interface to open in Show supported languages. Default value: en (English) |
document_info | { "document_name":"New", "document_id":"1349" } | Set an unique id and specify a display name for the presentation. |
password | String | Specify the password for the input file when importing a password-protected document using this parameter. |
document_info
Parameter | Type | Possible Values | Default Value |
document_id | string | Alphabets, Numbers, Hyphen, Underscore and Dot. | Example: abc/3 |
document_name | string | My_Presentation | Untitled |
Preview Presentation - Error Codes
Code | Description |
3802 | Unable to import |
3835 | File size limit exceeded. The maximum allowed size is 100 MB |
3842 | Invalid file extension |
3845 | Content type did not match |
For a full list of error handling cases in Preview Presentation, refer here.
Sample Request
Copiedcurl --request POST \
--url 'https://api.office-integrator.com/show/officeapi/v1/presentation/preview' \
--header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
--form document=@/Users/username/Presentation/Sample.pptx \
--form 'apikey=423s*****' \
--form language=en \
--form document_info={'\''document_name'\'':'\''New'\'', '\''document_id'\'':1349} \
--form password=a1b2c3****
Sample Response
Copied{ "preview_url":"https://api.office-integrator.com/show/officeapi/presentaton/preview/d26aa7b8029bf4f8d34c7dd0013939237c7426dd7b014b7c5cd9fa07cdd21f0e304693ffbf26ba091b4f8d5350ec9bb8/open",
"session_id": "d26aa7b8029bf4f8d34c7dd0013939237c7426dd7b014b7c5cd9fa07cdd21f0e304693ffbf26ba091b4f8d5350ec9bb8",
"document_id": "1349",
"session_delete_url": "https://api.office-integrator.com/show/officeapi/v1/session/d26aa7b8029bf4f8d34c7dd001393923ec7a56cea9631855c708129cbd74491775f200eb5821ba0193ab987c514887c4",
"document_delete_url": "https://api.office-integrator.com/show/officeapi/v1/presentation/1349"
}