Editing Presentation

Purpose 

To edit a presentation in Zoho Show.

HTTP Request URL

https://show.zoho.com/show/remotedoc.im

Request Parameters

ParameterData TypeDescription
Mandatory Parameters
apikeyStringUniquely identifies the web application in which the Show editor is integrated.
content

or

url		File

or

String		Method of providing the input file depending on its location.

content - if the input file is from your local drive or desktop.

url - if the input file is from a publicly accessible Web URL.
modeStringDefines the access privilege of the user while opening the presentation in Show editor.
normaledit - Presentation opens exclusively in edit mode for the user. No other collaborator is allowed.  
formatStringDefines the format in which the presentation needs to be saved back to the partner's storage server.
Supported file formats: .ppt .pptx .pps .ppsx .odp .sxi
Max. file size: 100MB 
saveurlStringDefines partner's storage server location. The saveurl is a publicly accessible web URL/Service, to which Zoho will push the updated presentation content from Show editor to the partner's server.
Optional Parameters
documentidIntegerUnique id for document identification. In the case of user failing to provide a documentid, Writer will generate one automatically in the form of an encrypted string.
idStringUnique session id or callback id used to store presentation-related information, including session id, list of shared users, doc id, etc.
langStringEnables the Show editor interface to open in different languages.
Default value: en (English)

 

Editing Presentation - Error Codes

CodeDescription
3831Mandatory parameter(s) missing.
3890Invalid API key
3894Zoho account associated with this API Key is deleted.

For a full list of error handling cases in Editing Presentation, refer here.

saveurl param usage:

Zoho Office Integrator allows partners and businesses to save the document content back to their specified storage server through "saveurl" method.

A saveurl is a publicly accessible web URL/Service to which Zoho will push the updated presentation content from Show editor to the partner's server.

In order to use the saveurl method, partners should fulfill the below requirements:

  1. Partner's remote servers need to expose one of their ports - port 443 (HTTPS) or port 80 (HTTP) - from their location, for Zoho Show to push the data back.
  2. The saveurl value specified in the HTTPS/HTTP POST request should be a proper domain name and publicly accessible over the web. Example: https://yourdomain.com/save.php

 

Document Session Id Parameter

To store document-related information, Zoho provides partners with a specific parameter called "id".

The 'id' parameter, also known as document session id, can be used by partners to pass additional information on the document when sending the HTTPS POST request to Zoho.

The information provided in the 'id' parameter will be returned by Zoho to the partner's document repository every time a 'Save' is invoked from the Zoho Office editors. A few possible use-cases are:

  • Get to know who has saved the document in collaboration mode.
  • Assign shared user information as 'JSON/XML' string in the 'id' parameter value. Zoho will return the details of which user has saved the document in collaboration mode.
  • Any information pertaining to the partner's web application. This may include file type, file id, folder id, where the doc needs to be saved, etc.

Sample Request:

Copiedcurl --request POST \
  --url 'https://show.zoho.com/show/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Presentations/Sample.pptx \
  --form mode=normaledit \
  --form lang=en \
  --form 'saveurl=https://example.com/saveurl?key=value' \
  --form format=xlsx

Sample Response:

CopiedRESULT=TRUE
URL=https://docs.zoho.com/show/remoteview.sas?
doc=55ba74a15b81a67b9a5160c17457cb9935326c1b2daa60a3fd618c74d88c456c92e82a1d902a110b0ef2ebd526a8fb38