Navbar
+

Introduction

Zoho Office API is for all applications that store documents as part of business process or services. The focus is especially on partners and businesses who have a web application of their own and require feature-rich Office editors for their document management needs. Instead of spending a fortune on desktop-based Office software, partners can integrate Zoho Office editors for viewing/editing documents with the added assurance of their data residing in their own document servers.  

The Zoho Office API is an expanding portfolio of functionality and depth that provides partners and businesses with a simple way to integrate fully featured Zoho Office Editors - Writer, Sheet, Show - into their existing applications, portals and websites. Some of the immediate benefits of Office API integration include:

Ease of use and integration: The Zoho Office API can be developed in multiple programming languages (Java, PHP, C# to name a few) and integrated into any type of application environment saving businesses a lot of time and energy as well as eliminating risk associated with complex deployments.

Extend the value and reach of your business applications: Partners increase the value of their offering by combining the features and benefits of integrated Zoho Office Suite with the services they already provide potentially increasing revenues and user retention.

Remote Access: With Zoho Office API integration, partners can store data locally while accessing Zoho Office Editors in the cloud. This functionality is the key distinguishing factor of the Office API program. Many businesses want to leverage the benefits of cloud computing but prefer to have their documents stored on their servers.

Enhanced Collaboration and Productivity: Businesses now do not need to maintain several iterations of their documents. The Zoho Office Editors is equipped with built-in collaboration feature that allow users to open desktop documents in their browsers , invite participants to collaboratively edit and save a single copy of the document. 

The integrated Chat enables users to collaborate in real time while co-editing documents.

How it works?

The Zoho Office API model is partner hosted. The documents reside locally on the partner's storage servers. Zoho's fully featured Office editors, exposed through the APIs, upload the document content, do the edits and push the updated content back to their servers when save is invoked. No document is stored in Zoho servers.

With Zoho Office API, you can:

  1. Create a new document or open existing documents directly from your web application.
  2. View and edit documents based on the access privileges defined by the administrator of your web application.
  3. Collaborate on the documents in real-time.
  4. Save the document content back to your document servers.

Getting started

In order to make use of the Zoho Office API, partners and businesses need to first "create a free Zoho account" and then proceed to "obtain an apikey".

The apikey uniquely identifies the application in which you integrate Zoho Office Suite and is associated with your Zoho Account. 

The apikey is mandatory and needs to be passed as a parameter in every request for opening/editing documents in Zoho's Office Editors - Writer, Sheet, Show.

We use the apikey to track usage of various applications and generate reports based on them. Each partner application that has Zoho Office Editors integrated should have a separate Zoho account and a unique apikey associated with it.

Create a Zoho account

  1. Access the "Sign Up" URL
  2. Fill in requisite details like your Full Name, Email Address and Password.
  3. Click "Sign Up".You will be directed to the API Key registration page after signing in successfully.

Generate your apikey

Once you have signed up for a Zoho account, you can get an apikey by performing the following steps: 

  1. Access the Zoho Office API "Sign In" page and enter your Zoho Account details.
  2. Fill out the apikey registration form that will look like the one below:

  3. Click "Generate apikey" button.

Once you complete the apikey registration process, you will be taken to your account dashboard.

The alphanumeric apikey, as seen from the account dashboard, can now be used to make API calls, view/edit documents and perform specific actions.

The apikey is unique and is connected to your Zoho account. Please keep the apikey private. Do not distribute or use the apikey in multiple web applications/services. You should request an apikey for each individual application/service that you plan to integrate Zoho Office Suite into. Any violations will result in cancellation of the apikey and suspension of your Zoho account.

Postman Collection

You can use Postman to try out Office API. Postman is a widely used REST Client for API development and testing. Download and import our API collecting by clicking the button below:


Once you import the collection, you need to configure the environment. Do it manually or download our sample environment by following the steps below:

  1. Download the sample environment file for Office API.
  2. Replace values for the following:
    • apikey: {{apikey}}
    • writer.domain: writer.zoho.com
    • sheet.domain: sheet.zoho.com
    • show.domain: show.zoho.com

    For EU Domain users,

    • writer.domain: writer.zoho.eu
    • sheet.domain: sheet.zoho.eu
    • show.domain: show.zoho.eu

    For CN Domain users,

    • writer.domain: writer.zoho.cn
    • sheet.domain: sheet.zoho.cn
    • show.domain: show.zoho.cn
  3. Now click the Settings icon from the postman app and click Manage environment.
  4. Click Import and upload the provided sample environment file.

Developer reference

The Developer Reference covers the use and implementation of Zoho Office APIs. Developers will learn, through practical examples, how to integrate Zoho Office editors in their web application. 

Zoho Office APIs are intended for anyone with basic programming skills in any language - Java, PHP, C# etc., and a general understanding of Web applications and how they work. This document assumes that partners/developers who intend to implement Office API in their web application, understand the basics of Web services, XML, JSON and the GET & POST requests in HTTPS.

HTTP status code summary

Error Code Description
200 OK
Successful API request.
400 BAD REQUEST
User error. This is due an an invalid parameter or combination of parameters provided is invalid.
404 NOT FOUND
The user does not have read access to the file, or the requested file does not exist.
500 INTERNAL SERVER ERROR
This is a backend error encountered due to an unexpected server behavior.

HTTP Methods

GET To get data from a given server.
POST To upload data to the server.

The next section will provide developers with a detailed API documentation of each Zoho Office Editors (Writer, Sheet, and Show) and explain how to:

  1. Open a file in Zoho Office Editors to view and edit.
  2. Create a new file.
  3. Collaborate on a file.
  4. Save a file in partner's storage server.

Zoho Writer

Zoho Writer is a powerful online word processor to create and edit documents. With its Editor API, partners can integrate the feature-rich Writer Editor in their Web application and work on standard Microsoft Word and OpenOffice documents right from the web browser.

Zoho Office API for Writer supports all popular formats: .doc .docx .rtf .txt .odt .html .sxw 

Editor API

The Editor API allows you to view and edit documents stored in your server from within online Writer editor. It also allows users of your web application to collaborate on documents in the integrated Writer editor.

Editing Document

Sample Request:

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

Sample Response:

URL=https://writer.zoho.com/writer/editor.im?
doc=1b0cbfb1bf7e106eba167682e5b3be1f536cacf4451f1f896a227254e7554d0783591576a98d96e090cec38469a8f46f WARNING=NULL RESULT=TRUE

Purpose

To edit a document in Zoho Writer Editor.

HTTP Request URL

POST https://writer.zoho.com/writer/remotedoc.im

Parameters

apikeystring Required. Uniquely identifies the web application in which the Writer editor is integrated.
contentstring The document content to be uploaded to Writer Editor. A new document will be created if there is no content.
urlstring For opening documents that are present over a web url.
modestring

Required. Defines access privilege of the user while opening the document in Writer editor.
normaleditDocument opens exclusively in edit mode for the user. No other collaborator is allowed.

langstring

Enables the Writer editor interface to open in different languages.
Default value:
en (English)

idstring

Unique document session id or callback id used to store document-related information, including session id, list of shared users, doc id, etc.

saveurlstring

Required. Defines partner's storage server location. The saveurl is a publicly accessible web URL/Service, to which Zoho will push the updated document content from Writer editor to the partner's server.

formatstring

Required. Defines the format in which the document needs to be saved back to the partner's storage server.
Supported file formats: .doc .docx .rtf .txt .odt .html .sxw 

Viewing Document

Sample request:

 curl --request POST \
  --url 'https://writer.zoho.com/writer/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.docx \
  --form mode=view \
  --form lang=en

Sample response:

URL=https://writer.zoho.com/writer/editor.im?
doc=1b0cbfb1bf7e106eba167682e5b3be1fcc0deaa94cb8c7c0b856341c31d56b19a08094597595c7c122d3338b6a7683e5 WARNING=NULL RESULT=TRUE

Purpose

To view a document in Zoho Writer.

HTTP Request URL

POST https://writer.zoho.com/writer/remotedoc.im

Parameters

apikeystring Required. Uniquely identifies the web application in which the Writer editor is integrated.
contentstring Required. The document content to be uploaded to Writer Editor.
urlstring For opening documents that are present over a web url.
modestring

Required. Defines access privilege of the user while opening the document in Writer editor.
view - Document opens in view or read-only mode for the user. 

langstring

Enables the Writer editor interface to open in different languages.
Default value:
en (English)

Customize Save Notifications

Partner's web application can customize the save notifications sent to Zoho servers. The message is shown when the user saves a document from Zoho Office editor. We handle both the success and failure save notification cases. Details below:

  1. Success Notification (HTTP response code 200) - Sent when the document is saved successfully. 
  2. Error Notification (HTTP response code 500) - Sent when the document save fails.

The response to be sent to Zoho servers is of the format: 

RESPONSE: [Custom Success or Failure Notification from the partner's web application] 

In case the partner application fails to provide a custom message of its own, Zoho will display its default save notification message in its Office editors.

Co-editing Document

Sample request:

 curl --request POST \
  --url 'https://writer.zoho.com/writer/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.docx \
  --form mode=collabedit \
  --form lang=en

Sample response:

URL=https://writer.zoho.com/writer/editor.im?
doc=1b0cbfb1bf7e106eba167682e5b3be1fcc0deaa94cb8c7c0b856341c31d56b19a08094597595c7c122d3338b6a7683e5 WARNING=NULL RESULT=TRUE

Zoho Office API supports real-time document collaboration. This means several users can open a particular document at the same time, with everyone being able to contribute to the document in real time. 

With built-in collaboration features, businesses can enhance user productivity, foster teamwork, and cooperation. When a document is shared with others, teams can work together in the same instance - so when someone makes a change, the document is updated for everyone to see. Also, the integrated Zoho Chat application allows each user to communicate in real time and see who else is available.

Purpose

To co-edit a particular document in Zoho Writer.

HTTP Request URL

POST https://writer.zoho.com/writer/remotedoc.im

Parameters

Parameter Name Description
apikeystring Required. Uniquely identifies the web application in which the Writer editor is integrated.
contentstring Required. The document content to be uploaded to Writer Editor. A new document will be created if there is no content. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the document in Writer editor.
collabedit - Document opens in real-time collaborative edit mode. Multiple users can edit the document as well as add notes/comments at the same time. 
documentidstring Required. Unique 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.
langstring Enables the Writer editor interface to open in different languages.
Default value:
en (English)

saveurlstring

Required. Defines partner's storage server location. The saveurl is a publicly accessible web URL/Service that fetches the content of the updated document from Writer editor and saves it to the partner's storage server.
usernamestring Identifies the name of the user opening a document in collaboration mode.
Default value: Guest
formatstring Required. Defines the format in which the document needs to be saved back to the partner's storage server.
Supported file formats: .doc .docx .rtf .txt .odt .html .sxw 

Conversion API

Sample request:

 curl --request POST \
  --url 'https://writer.zoho.com/writer/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.docx \
  --form mode=collabedit \
  --form lang=en

Zoho Writer’s conversion API let’s you easily integrate document conversion functionality to web applications and content management systems.  

The conversion API allows you convert a file format (say docx) to another file format (say pdf or text).

Apart from supporting popular file formats like .docx .doc .txt .pdf .odt .sxw and .html. Zoho Writer also enable file conversion in its native .zdoc format. 

Purpose

To convert a document to any Writer supported format (.docx, .doc, .pdf, .zdoc etc.)

HTTP Request URL

POST  https://writer.zoho.com/writer/v1/remote/conversion

Parameters

Parameter Name Description
apikeystring Required. Uniquely identifies the web application which initiates the document conversion request.
content string Required. Method of providing the input file depending on its location. content (if input is raw/base64). 
formatstring Required. Output file format, to which the file should be converted to.
Supported file formats: .docx .doc .txt .pdf .odt .sxw .html and .zdoc

Comparison API

Sample request:

 curl -X POST \
   'https://writer.zoho.com/writer/v1/remote/comparedocs?apikey=1ee6127ff93882de82599eacc2668023' \
  -H 'Cache-Control: no-cache' \
    -H 'content-type: multipart/form-data; 
    boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -F  doc1=@/Users/username/Documents/master.docx \
  -F doc2=@/Users/username/Documents/receipt.docx'

Zoho Writer comparison API provides a user-friendly viewer for comparing documents.

The API accepts a pair of documents as input and returns a comparison viewer URL as a response. When a user accesses the said URL in a browser, the documents are displayed in Writer with changes highlighted.

Purpose

To compare two versions of a document and highlight the difference in text.

HTTP Request URL

POSThttps://writer.zoho.com/writer/v1/remote/comparedocs

Parameters

Parameter Name Description
apikeystring Required. Uniquely identifies the web application, which initiates the document comparison request.
doc1

Required. Input 1st version of the document. content (if input is raw/base64).

doc2

Required. Input 2nd version of the document. content (if input is raw/base64).

Zoho Sheet

Zoho Sheet is a powerful spreadsheet editor that lets you create and edit complex spreadsheets online. With its Editor API, partners can integrate the feature-rich Sheet Editor in their Web application and work on standard Microsoft Excel and OpenOffice spreadsheets right from the web browser.

Zoho Office API for Sheet supports all popular formats: .xlsx .xls .ods .sxc .csv .tsv 

Editor API

The Editor API for Zoho Sheet allows developers to integrate the Sheet Editor in their web application and create/open/view/edit online.  

Editing spreadsheet

Sample request:

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

Sample response:

RESULT=TRUE
URL=https://sheet.zoho.com/sheet/editor.do?
doc=d55ce7a40befa74f501a88646e84769d36ac363c817fef60d4fc0c0722ecdf9f860fe69a12c79cbfaee4ddb3c823bf0575edc5f3e793f3f9552b7205d94db136&lang=en

Purpose

To edit a spreadsheet in Zoho Sheet.

HTTP Request URL

POST https://sheet.zoho.com/sheet/remotedoc.im

Parameter

Parameter Name Description
apikeystring Required. Uniquely identifies the web application in which the Sheet editor is integrated.
contentstring Required. The spreadsheet content to be uploaded to Sheet Editor. A new spreadsheet will be created if there is no content. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the spreadsheet in Sheet editor.
normaledit - Spreadsheet opens exclusively in edit mode for the user. No other collaborator is allowed. 
langstring Enables the Sheet editor interface to open in different languages.
Default value:
en (English)
idstring Unique document session id or callback id used to store document-related information, including session id, list of shared users, doc id, etc.
saveurlstring Required. Defines partner's server location. The saveurl is a publicly accessible web URL/Service to which Zoho will push the updated spreadsheet content from Sheet editor to the partner's server.
formatstring Required. Defines the format in which the spreadsheet needs to be saved back to the partner's storage server.
Supported file formats: .xlsx .xls .ods .sxc .csv .tsv 

Viewing Spreadsheet

Sample request:

    curl --request POST \
  --url 'https://sheet.zoho.com/sheet/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.xlsx \
  --form mode=view \
  --form lang=en

Sample response:

RESULT=TRUE
URL=https://sheet.zoho.com/sheet/editor.do?
doc=d55ce7a40befa74f501a88646e84769d8370b12883da6d9c9539af282a869ede6f75603ca2c557c013ad9f9b1f992cbdd233e36e3b19a7b655e352d0a8e6f27b&lang=en

Purpose

To view a document in Zoho Sheet.

HTTP Request URL

POST https://sheet.zoho.com/sheet/remotedoc.im

Parameter Name Description
apikeystring Required. Uniquely identifies the web application in which the Sheet editor is integrated.
contentstring Required. The spreadsheet content to be created to Sheet Editor. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the document in Sheet editor.
view - Spreadsheet opens in view or read-only mode for the user. 
langstring Enables the Sheet editor interface to open in different languages.
Default value:
en (English)

Co-editing Spreadsheet

Sample Request:

 curl --request POST \
  --url 'https://sheet.zoho.com/sheet/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.xlsx \
  --form mode=collabedit \
  --form lang=en

Sample Response:

RESULT=TRUE
URL=https://sheet.zoho.com/sheet/editor.do?
doc=d55ce7a40befa74f501a88646e84769d8370b12883da6d9c9539af282a869ede6f75603ca2c557c013ad9f9b1f992cbdd233e36e3b19a7b655e352d0a8e6f27b&lang=en

Purpose

To co-edit a particular document in Zoho Sheet.

HTTP Request URL

POST https://sheet.zoho.com/sheet/remotedoc.im

Parameter Name Description
apikeystring

Required. Uniquely identifies the web application in which the Sheet editor is integrated.
contentstring Required. The spreadsheet content to be uploaded to Sheet Editor. A new spreadsheet will be created if there is no content. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the spreadsheet in Sheet editor.
collabedit - spreadsheet opens in real-time collaborative edit mode. Multiple users can edit the document as well as add notes/comments at the same time. 
documentidlong integer Required. Unique id for spreadsheet identification. In the case of user failing to provide a documentid, Zoho Sheet will generate one automatically in the form of an encrypted string.
langstring Enables the Sheet editor interface to open in different languages.
Default value:
en (English)
saveurlstring Defines partner's storage server location. The saveurl is a publicly accessible web URL/Service that fetches the content of the updated document from Writer editor and saves it to the partner's storage server.
formatstring Required. Defines the format in which the spreadsheet needs to be saved back to the partner's storage server.
Supported file formats: .xlsx .xls .ods .sxc .csv .tsv 

Zoho Show

Zoho Show is an online presentation tool that lets you create, collaborate, present, broadcast and publish presentations, the smarter way. With its Editor API, partners can integrate the feature-rich Show Editor in their Web application and work on standard Microsoft PowerPoint and OpenOffice presentations right from the web browser.

Zoho Office API for Show supports all popular formats: ppt pptx pps ppsx odp sxi

Editor API

The Editor API for Zoho Show allows developers to integrate the Show Editor in their web application and create/open/view/edit online.  

Editing Presentation

Sample Request:

  curl --request POST \
  --url 'https://show.zoho.com/show/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.pptx \
  --form mode=normaledit \
  --form filename=test.pptx 

Sample response:

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

Purpose

To edit a presentation in Zoho Show.

HTTP Request URL

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

Parameters

Parameter Name Description

apikeystring

Required. Uniquely identifies the web application in which the Show editor is integrated.
contentstring Required. The presentation content to be uploaded to Show Editor. A new presentation will be created if there is no content. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the spreadsheet in Show editor.
normaledit - Presentation opens exclusively in edit mode for the user. No other collaborator is allowed. 
langstring Enables the Show editor interface to open in different languages.
Default value:
en (English)
idstring Required. Unique session id that user needs to provide when opening a presentation in Zoho Show.
The 'id' parameter can be used to store all relevant presentation-related information, including session id, list of shared users, doc id etc., in the form of encoded string.
The information in 'id' parameter will be returned to the 'saveurl' by Zoho Show whenever 'save' is invoked by the user. 
saveurlstring Defines partner's storage server location. The saveurl is a publicly accessible web URL/Service that fetches the content of the updated presentation from Show editor and saves it to the partner's storage server.
formatstring Required. Defines 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

Viewing Presentation

Sample Request:

  curl --request POST \
  --url 'https://show.zoho.com/show/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.pptx \
  --form mode=view \
  --form filename=test.pptx 

Sample Response:

RESULT=TRUE
URL=https://docs.zoho.com/show/remoteedit.sas?
doc=55ba74a15b81a67b9a5160c17457cb9909fb9b2457bdf5ffb40c383dbe44db12be63a39af6e2507ca1ba811cc4821564

Purpose

To view a presentation in Zoho Show.

HTTP Request URL

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

Parameter Name Description
apikeystring Required. Uniquely identifies the web application in which the Show editor is integrated.
contentstring Required. The presentation content to be uploaded to Show Editor. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the presentation in Show editor.
view - Presentation opens in view or read-only mode for the user. 
langstring Enables the Show editor interface to open in different languages.
Default value:
en (English)

Supported file formats: ppt pptx pps ppsx odp sxi

Maximum file size: 100MB

Co-editing Presentation

Sample Request:

  curl --request POST \
  --url 'https://show.zoho.com/show/remotedoc.im?apikey=1ee6127ff93882de82599eacc2668023' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form content=@/Users/username/Documents/Sample.pptx \
  --form mode=collabedit \
  --form filename=test.pptx 

Sample Response:

RESULT=TRUE
URL=https://docs.zoho.com/show/remoteedit.sas?
doc=55ba74a15b81a67b9a5160c17457cb9909fb9b2457bdf5ffb40c383dbe44db12be63a39af6e2507ca1ba811cc4821564

Purpose

To co-edit a particular presentation in Zoho Show.

HTTP Request URL

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

Parameters

Parameter Name Description
apikeystring

Required. Uniquely identifies the web application in which the Show editor is integrated.
contentstring Required. The presentation content to be uploaded to Sheet Editor. A new presentation will be created if there is no content. 
urlstring For opening documents that are present over a web url.
modestring Required. Defines access privilege of the user while opening the presentation in Show editor.
collabedit - presentation opens in real-time collaborative edit mode. Multiple users can edit the presentation as well as add notes/comments at the same time. 
documentidlong integer

Required. Unique id for presentation identification.
In the case of user failing to provide a documentid, Zoho Show will generate one automatically in the form of an encrypted string.

langstring Enables the Show editor interface to open in different languages.
Default value:
en (English)
saveurlstring Required. Defines partner's storage server location. The saveurl is a publicly accessible web URL/Service that fetches the content of the updated presentation from Show editor and saves it to the partner's storage server.
formatstring Required. Defines 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

Errors

Zoho Writer - Errors

Error Code Description
1801/02/03 Internal Server Error while processing this request.
1831 Mandatory parameter(s) missing.
1840 Unable to import content from the specified URL.
1841 Unable to import content. 
1842 Invalid file extension
1843 File name not found
1844 File extension not found
1845 Unable to allocate URL
1846 Unable to import content. Document malformed.
1847 Username not found. Please enter username.
1848 Missing "Id" parameter value.
1849 Import failed. Possible reasons:
- The "documentid" value provided is either incorrect or invalid.
- The document is either malformed or its file format is not supported by Zoho Writer
1850 The value specified for 'doc' parameter is missing or invalid.
1890 Invalid apikey
1891 The specific URL request is incorrect.
1893 UDS Limit or API usage exceeded
1894 Zoho account associated with this apikey has been deleted.

Zoho Sheet - Errors

Error Code Description
2801/02/03 Internal Server Error while processing this request.
2831 Mandatory parameter(s) missing.
2833 The Content-Type header set in your HTTP request is incorrect.
2840 Unable to import content from the specified URL.
2841 Unable to import content. 
2842 Invalid file extension
2843 File name not found
2844 File extension not found
2845 Unable to allocate URL
2846 Unable to import content. Spreadsheet malformed.
2847 Username not found. Please enter username.
2848 Missing "Id" parameter value.
2849 Import failed. Possible reasons:
- The "documentid" value provided is either incorrect or invalid.
- The document is either malformed or its file format is not supported by Zoho Sheet.
2850 RemoteDocStatus error: The value specified for 'doc' parameter is missing or invalid.
2890 Invalid apikey
2891 The specific URL request is incorrect.
2893 UDS Limit or API usage exceeded
2894 Zoho account associated with this apikey has been deleted.

Zoho Show - Errors

Error Code Description
3800 Unable to import the presentation
3801 Unable to export the presentation to {0} format
3803 Remote upload failed
3835 The file size exceeds the allowed size. The maximum allowed size is {0} MB
3839 Invalid filename
3840 The value specified for {0} is less than the minimum length ({1})
3841 Validation missing for {0}
3842 The value specified for {0} exceeds the maximum length ({1})
3843 More than {1} {0} is given
3845 Content type did not match
3846 Action Param {0} is missing in the request
3847 Virus Detected.
3848 XSS Detected
3849 The value specified for {0} is invalid. The allowed values are {1}.
3850 **Not available english
3852 The presentation with id {0} is trashed. Cannot be accessed
3890 API Key is not valid
3891 The specified request URI is incorrect
3893 UDS Limit Exceeded
3894 **we dont have such error code.

Manage Office API

Partners and users can view details related to API usage at any time from their Zoho Office API dashboard. There is also an option to view and edit documents in Zoho Office Editors from the Demo section. The Generate Code section has sample codes in different languages (curl, HTML) that simulates how you can open a file in our editors.

Dashboard

Once you have successfully logged in, you will be directed to the Zoho Office API dashboard that will provide you with the most essential details of your account. You will be able to view your API profile, plan details, and track API usage. 

Demo

The Office API Demo section is your playground where you can see how the integration works. You will be able to create, view, edit documents in Zoho Office editors as well as save the documents to your demo account. 

Generate Code

We have provided you with sample codes (curl, HTML) to open documents in "Generate Code" section. You can make use of the sample code and get started with the Office API integration right way.

Pricing

Once you have successfully signed up for your Zoho account and generated an API key, you can proceed to choose a pricing plan that works best for you:

  1. Access the "Dashboard" of your Office API account.
  2. Navigate to "Plan Details" section and click on 'Change Plan' button.
  3. You will be directed to the Subscription page where your current plan, expiry date and other details will be listed. 
  4. To upgrade/change your current plan, click on 'Upgrade Plan' button.
  5. Select the plan of your choice from the drop down and click 'UPGRADE'.
  6. Review your plan details again and click 'Continue'.
  7. Choose your payment method and enter your credentials there to complete your payment process.