Zoho API
Welcome to the Zoho API Page!
The Zoho Application Programming Interface (API) lets anyone write their own program to pull Zoho Writer, Zoho Sheet and Zoho Show data and work with the data in many possible ways.
The Zoho APIs are basically segregated into:
- Storage API- These APIs are used to manipulate data in different Zoho Services (Writer/Sheet/Show/Planner/Creator) but the updated data, as a result of various operations performed, is stored in Zoho Servers.
- Remote API - The remote API allows third party applications to make use of the feature rich editor of Zoho Services (Writer/Sheet/Show) and push the updated content into their own servers.
Accessing Zoho API
The users need to have an 'API Key' as well as a 'Ticket ID' for accessing the Zoho API. We use the API key to track usage. The ticket ID is required for authenticating the user for a particular Zoho service.
How to get the API Key?
Users can request for the API Key by registering themselves at the following url. Once we receive the request, we will be sending the API Key to the Email ID that the user has specified during the registration process. Please do not distribute or use the key for creating multiple services (you should request for an API key for each individual service that you plan to create). Any violations will result in the cancellation of the API Key. Getting this API Key is a onetime process.
How to generate Ticket ID?
To generate the ticket ID, users have to send the authenticated request to Zoho Accounts over a secured connection in the following URL format:
Request
https://accounts.zoho.com/login?servicename=[ZohoWriter/ZohoSheet/ZohoShow]&FROM_AGENT=true&
LOGIN_ID=[Zoho ID/Email ID]&PASSWORD=[Password]
The mandatory list of parameters to be passed in the URL are:
- servicename -- ZohoWriter, Zoho Show or ZohoSheet
- FROM_AGENT -- true
- LOGIN_ID -- Users' Zoho ID or Email ID
- PASSWORD -- Password for the Zoho ID
Depending on the parameters passed over the requested URL, the user will get a response in the following name/value format:
Response
#Comment
[name1]=[value1]\n
[name2]=[value2]\n
[name3]=[value3]\n
Example of a response
#Thu Oct 26 02:17:49 PST 2006
WARNING=
TICKET=543754375sdferuecmvc458545432dfffqq
RESULT=TRUE
Here
- #Comment -- Ticket generated date
- WARNING -- If the parameters passed in the URL are incorrect, the user will get a warning message stating the same otherwise the value will be null.
- TICKET -- Ticket generated for the request
- RESULT -- Value is true if the ticket is generated successfully, else it is false.
Storage API
There's a list of storage APIs for Zoho Writer, Sheet, Show, Planner and Creator available. The storage APIs currently being developed is based on REST style while the previous version of Zoho API now deprecated (but functional) were loosely based on RPC style. To get the list of API methods for the above Zoho services, please click on the appropriate link mentioned below :
- Zoho Writer API -- Allows client applications to view, list, create/edit and perform a host of useful operations on their Zoho Writer documents.
- Zoho Sheet API -- Allows client applications to view, list, read, modify/save, and rename the workbooks available on their Zoho Sheet accounts.
- Zoho Show API-- Allows client applications to view, list, embed, import, and perform a host of useful operations on their presentations.
- Zoho Planner API -- Allows client applications to perform a host of useful operations on their users' To-do lists, Appointments, Reminders & Notes.
- Zoho Creator API-- Allows external websites to collaborate with Zoho Creator applications, with ease. Users can now build their web application in PHP, JSP, ASP, Perl or on any other programming language while the data is stored in Zoho Creator. The APIs are broadly divided into ServerSide and ClientSide.
- Server Side API -- ServerSide API's allows users to programatically add, delete, update and view records in a ZohoCreator application. The ServerSide API's comes in two flavours: REST API's and RPC API's as listed below:
- Zoho DB & Reports API -- Based on REST style APIs over HTTP, the API allows an easy way for developers to integrate their applications with Zoho DB & Reports.
Remote API
Zoho Remote API allows any third-party application use the feature-rich editor of Zoho Writer/Sheet/Show for creating/editing documents/spreadsheets/presentations. For more on remote API's and its usage please refer to the links for the specific Zoho Services below:
# Zoho Writer Remote API
# Zoho Sheet Remote API
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 Zoho API write to us at
api@zohocorp.com.
