Zoho Show Remote API
The Zoho Remote Application Programming Interface (API) lets any third-party application use the feature-rich editor of Zoho Show for creating, viewing and editingNew! presentations. The API also allows such presentations created to be pushed to one's own remote servers for saving (the presentations aren't saved in Zoho Show's servers).
A sample presentation opened using Zoho Show's remote editor
Viewing a Remote Presentation in Zoho Show
Using multi-part form submit
To push the presentation from remote server (for making it load on the Zoho Show editor), submit a multi-part form-data to Zoho Show with the following fields
| Field |
Description |
| content |
actual presentation content
|
filename
|
filename of the presentation with extension
|
| id |
unique id that will be submitted while viewing the presentation (for reference) |
| format |
implies the presentation format (examples: ppt, pps )
|
| persistence(deprecated) |
persistence = true has been deprecated now and the default value of this parameter is set to false.
The document pushed to Zoho Servers will be editable only once. The
data will automatically be deleted from Zoho Servers when the user
closes the browser's session. |
Sample multipart form
<form method="POST" action="http://show.zoho.com/remotedoc.im?output=<view/url>&apikey=<Api Key>" enctype="multipart/form-data" target="_self">
File : <input type="file" name="content" size="38"> <br>
<input type="hidden" name="id" value="12345678">
<input type="hidden" name="format" value="ppt">
<input type="submit" value="View" class="divbutton" name="submit">
</form>
* In order to view a presentation in Zoho Show, it must be submitted as multi-part form data either from the client side or it can be done as an emulated multi-part form submission on the server side of the remote server.
Editing a Remote Presentation in Zoho ShowNew!
Using multi-part form submit
To push the presentation from remote server (for making it load on the Zoho Show editor) and do edit operatons, submit a multi-part form-data to Zoho Show with the following fields
| Field |
Description |
| content |
actual presentation content
|
filename
|
filename of the presentation with extension
|
| id |
unique id that will be submitted while viewing the presentation (for reference) |
| format |
implies the presentation format (examples: ppt, pps )
|
| persistence(deprecated) |
persistence = true has been deprecated now and the default value of this parameter is set to false.
The document pushed to Zoho Servers will be editable only once. The
data will automatically be deleted from Zoho Servers when the user
closes the browser's session. |
| saveurl |
[REMOTE SERVER SAVE URL] - The Web URL should be a service that fetches the content of the updated document and saves it to the user specified location. It should have a proper domain name and not mentioned as IP address. |
Sample multipart form
<form method="POST" action="http://show.zoho.com/remotedoc.im?output=<editor/editorurl>&apikey=<Api Key>" enctype="multipart/form-data" target="_self">
File : <input type="file" name="content" size="38"> <br>
<input type="hidden" name="filename" value="mypresn.ppt">
<input type="hidden" name="saveurl" value="[Remote Server Save URL]">
<input type="hidden" name="id" value="12345678">
<input type="hidden" name="format" value="ppt">
<input type="submit" value="Edit" class="divbutton" name="submit">
</form>
* In order to edit a presentation in Zoho Show, it must be submitted as multi-part form data either from the client side or it can be done as an emulated multi-part form submission on the server side of the remote server.
API URLNew!
To access the multi-part form based remote API, the users should post to the following URL format mentioned below :
http://show.zoho.com/remotedoc.im?apikey=<apikey>&output=view/editor/url/editorurl
The output parameter decides the format in which output will be sent. Currently Zoho Show allows four different values that can be passed in the output parameter. They are -
- view - By passing 'view' as the output value, the response will be javascript code snippet which automatically loads Zoho Show slideshow for users to view the presentation.
- url - By passing 'url' as the output value, users will get a response of the presentation in form of a url clicking on which will automatically load the presentation in slideshow mode for viewing.
- editor - By passing 'editor' as the output value the response will be javascript code snippet which automatically loads Zoho Show editor with the presentation content opened for editing the presentation.
- editorurl - By passing 'editorurl' as the output value, users will get a response of the presentation in form of a url clicking on which will automatically load the presentation in Zoho Show's editor for further editing.
by default the response will be a URL
Response Format for URL request:
URL = [url value 1]
WARNING = [Warning Message]
RESULT = [TRUE/FALSE]
RESULT field indicates the status of the action
Sample Response:
URL=http://show.zoho.com/remoteview.im?doc=C77076EG003waI770c1
WARNING=
RESULT=TRUE
Viewing a Remote Presentation in Zoho Show
Using normal form submit
To push the presentation from the remote server, submit a form to Zoho Show with the following form fields.
| Field |
Description |
url
|
url from which zoho show can fetch the presentation
Note : it is mandatory to specify the absolute path of the document in url parameter with proper file extension. |
| filename |
filename of the presentation with extension |
| id |
unique id that will be submitted while saving the presentation (reference) |
| format |
implies the presentation format (examples: ppt, pps )
|
| persistence(deprecated) |
persistence = true has been deprecated now and the default value of this parameter is set to false.
The document pushed to Zoho Servers will be editable only once. The
data will automatically be deleted from Zoho Servers when the user
closes the browser's session. |
Sample form
<form method="POST" action="http://show.zoho.com/remotedoc.im?output=<view/url>&apikey=<Api Key>" target="_self">
<input type="hidden" name="url" value="[http://xyz.com/presentations/abc.ppt]">
<input type="hidden" name="filename" value="myshow.ppt">
<input type="hidden" name="id" value="12345678">
<input type="hidden" name="format" value="ppt">
<input type="hidden" name="persistence" value="false">
<input type="submit" value="View" class="divbutton" name="submit">
</form>
* In order to view a presentation in Zoho Show, it must be submitted as form data either from the client side or it can be done as a emulated form submission on the server side of the remote server.
Editing a Remote Presentation in Zoho ShowNew!
Using normal form submit
To push the presentation from the remote server, submit a form to Zoho Show with the following form fields.
| Field |
Description |
url
|
url from which zoho show can fetch the presentation
Note : it is mandatory to specify the absolute path of the document in url parameter with proper file extension. |
| filename |
filename of the presentation with extension |
| id |
unique id that will be submitted while saving the presentation (reference) |
| format |
implies the presentation format (examples: ppt, pps )
|
| persistence(deprecated) |
persistence = true has been deprecated now and the default value of this parameter is set to false.
The document pushed to Zoho Servers will be editable only once. The
data will automatically be deleted from Zoho Servers when the user
closes the browser's session. |
| saveurl |
[REMOTE SERVER SAVE URL] - The Web URL should be a service that fetches the content of the updated document and saves it to the user specified location. It should have a proper domain name and not mentioned as IP address. |
Sample form
<form method="POST" action="http://show.zoho.com/remotedoc.im?output=<editor/editorurl>&apikey=<Api Key>" target="_self">
<input type="hidden" name="url" value="[http://xyz.com/presentations/abc.ppt]">
<input type="hidden" name="saveurl" value="[REMOTE SERVER SAVE URL]">
<input type="hidden" name="filename" value="myshow.ppt">
<input type="hidden" name="id" value="12345678">
<input type="hidden" name="format" value="ppt">
<input type="hidden" name="persistence" value="false">
<input type="submit" value="Edit" class="divbutton" name="submit">
</form>
* In order to edit a presentation in Zoho Show, it must be submited as form data either from the client side or it can be done as a emulated form submission on the server side of the remote server.
Saving the presentation in remote server
The presentation which is edited in Zoho Show's editor will be pushed to the remote server using multi-part/normal form submission from the Zoho Server. The URL to be used is specified at the time of pushing the presentation from remote server in the saveurl parameter of the form code.
In order to process the saving of a presentation, the remote server should understand multi-part form submission with the fields as mentioned below :
| Field |
Description |
| format |
the format in which the presentation should be saved on the remote server (examples: ppt, pps, odp, html, pdf) |
content
|
presentation content in desired format
|
| filename |
filename of the presentation with extension |
| id |
unique id that was initially sent while pushing the presentation from remote server (reference) |
Zoho API is an easy way to integrate Zoho Services into your application. Do have a go at the APIs by signing up for the key now. If you have any further questions regarding the Zoho API, write to us at api-support@zohocorp.com.
Note : It is mandatory to have the remote server address set to port number 80 for all the upload and download operations.
