Download APIs


This topic is deprecated. Please access the new set of "Download APIs" from over here: "https://www.zoho.com/docs/zoho-docs-api.html#download" 




Download APIs

Zoho's list of download APIs allows you to export documents, spreadsheets(both private and public) and presentations in different file formats. All you need to do is enter the request URIs in your browser address bar along with authentication parameters (apikey, authtoken, scope) and press enter. Once you do that, a dialog box will open which will prompt you to save the document to your local drive or open it with default application.

Request URI :

Developers can send the request for downloading documents in the following URI format :

Zoho Writer (Documents) :
https://writer.zoho.com/api/<access>/<downloadformat>/download/<documentid>?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI
Zoho Sheet (Spreadsheets) :
https://sheet.zoho.com/api/<access>/<downloadformat>/download/<bookid>?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI
Zoho Show (Presentations) :
https://show.zoho.com/api/<access>/<downloadformat>/download/<presentationid>?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI
Access : private or public

Download Parameters Reference

Parameter Value
 Description
documentid / bookid /
presentationid
 integer
 Mandatory. Specifies the unique document/spreadsheet/presentation id to download.
downloadformat
 string
 Mandatory. Specifies the file format in which the documents need to be downloaded.

Possible values for documents : doc, docx, pdf, html, htm, odt, rtf, txt
Possible values for spreadsheets : xls, xlsx, ods, sxc, pdf, html, csv, tsv
Possible values for presentations : ppt, pps, odp, pdf

Similarly, to download all the public spreadsheets available in Zoho Sheet, just replace the access value from "private" to "public" in the request URI. Support for downloading public documents & presentations is not provided for now.
 
Note : Downloading of shared documents is not supported as of now.
 Specific Download APIs for Zoho Sheet

There are certain sheet-related APIs that allow users to download the details of a particular sheet of a workbook as well as get data of a specific cell range in various formats. Details are below :

Download Methods

URI Request
Description
 Sheet: https://sheet.zoho.com/api/private/csv/download/[bookid]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI
 Download the first sheet of a workbook in csv (comma separated values) format.
Sheet: https://sheet.zoho.com/api/private/tsv/download/[bookid]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI 
 Download the first sheet of a workbook in tsv (tab separated values) format. 
Sheet: https://sheet.zoho.com/api/private/csv/download/[bookid]/sheet-name:[name]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI 
 Download a specific sheet of a workbook by sheet name in csv comma separated values) format
Sheet: https://sheet.zoho.com/api/private/csv/download/[bookid]/[sheetIndex]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Download a specific sheet of a workbook by sheet index in csv comma separated values) format
Sheet: https://sheet.zoho.com/api/private/csv/download/[bookid]/[sheetIndex]/[range]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI
 		Download a specific cell range within a sheet by its sheet index value in csv format.
Sheet: https://sheet.zoho.com/api/private/csv/download/[bookid]/sheet-name:[name]/[range]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI 
 		 Download a specific cell range within a sheet by its sheet name in csv format.

Similarly, to download specific sheets of a public workbook in Zoho Sheet, just replace the access value from "private" to "public" in the request URI.

    Post a comment

    Your Name or E-mail ID (mandatory)

    Note: Your comment will be published after approval of the owner.



    		 RSS of this page