Zoho Sheet

Tags:  

Zoho Sheet - Data APIs


Zoho Sheet provides REST style web APIs which allows a client application to view, modify, upload, download and perform host of other useful operations on their workbooks. Thus, these APIs provide an easy way to integrate Zoho Sheet workbooks into your application.

The previous version of our APIs were loosely based on RPC style. But the current version is based on REST style as it's more easy to use. The old APIs are deprecated (but functional) now. It's API reference can be found here.

To get started with our REST APIs, please refer our API Reference.

REST Request Format

As discussed here, while sending the REST requests, two additional parameters needs to be sent. They are 'apikey' and 'ticket'.

1. Read Operations:

For read like operations, HTTP GET/POST calling convention is used.

The read APIs are further segregated into user specific details (Private) and details that are made available for everyone to view (Public).
  • URIs for manipulating user specific details start with "/api/private/".
    For example, to get the list of workbooks available in your account the url "http://sheet.zoho.com/api/private/xml/books" can be used.
  • URIs for exposing public details start with "/api/public/".
    For example, to get the list of public workbooks in ZohoSheet the url "http://sheet.zoho.com/api/public/xml/books" can be used.Moreover these set of APIs do not require authentication and hence users need not pass 'ticket' as query parameter.
2. Write Operations:

For write operations like renaming or updating a workbook, HTTP POST calling convention is used.HTTP GET is not supported for write operations

REST Response Format

The type of response being generated will depend on the 'format' specified in the request URL.

The URL will be of the form

http://sheet.zoho.com/api/[private or public]/[format]/...

Currently, the following response formats are supported
  • XML
  • JSON
    • JSONP (JSON callback) support is available.
For example,

-- "http://sheet.zoho.com/api/public/xml/books" will return the list of publicly available workbooks in XML format.
-- "http://sheet.zoho.com/api/public/json/books" will return the list of publicly available workbooks in JSON format.

Response Structure

The response will have the <response> tag as the root node. It might either contain a <result> or <error> node as it's child, but not both. The <result> node will be present under normal circumstances, whereas <error> node will be present in case of error conditions.

Thus, normal response will be of the form

<?xml version="1.0" encoding="UTF-8" ?> 
<response uri="[request URI]">   
<result>           
[specific XML response here] 
</result> 
</response>

In case of error conditions, say we are referring to a document not present in Zoho Sheet, the response will be of the form

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="[request URI]">

<error>
<code>[error code]</code>
<message>
[Error Message]
</message>
</error>

</response>


For a full list of REST API methods, please click here.
 

 RSS of this page