Subscribe: Zoho APIs
Added By: Feedage Forager Feedage Grade B rated
Language: English
api  apikey  apos  authtoken authtoken  authtoken scope  authtoken  content  document  documents  https  user  writer  zoho api  zoho 
Rate this Feed
Rate this feedRate this feedRate this feedRate this feedRate this feed
Rate this feed 1 starRate this feed 2 starRate this feed 3 starRate this feed 4 starRate this feed 5 star

Comments (0)

Feed Details and Statistics Feed Statistics
Preview: Zoho APIs

Zoho API Help Center

Published: Fri Feb 12 00:00:00 PST 2016


Zoho-API---Commercial-Terms :: Version3.1
The Zoho API program is geared towards providing partners, non-profit organizations and end customers with a straightforward way of integrating various Zoho apps into your existing applications, services or working environment.We provide a free version with some limitations that may be suitable for your requirements. This is primarily aimed at partners who are in the process of developing their solution with Zoho APIs and early-adopters who anticipate a lower volume of usage.  The fee-based APIs provide partners, non-profits and end customers with a commercial relationship with Zoho Corp and a more business focused approach to their API integration. Partners will have access to a customized API dashboard that includes information on their API account, usage as well as billing and payment details. The fee-based APIs also provide secure document access, real-time collaboration & remote presentation features. Pricing Plan Details [ Applicable for Remote API only ] For Zoho API Partners/Non-profit organizations there are two commercial models based on whether your services are fee-based or offered for free. 1. Flat monthly fee model A: For partners/non-profits who provide their services/applications to users for free. Partners are charged a monthly fee based on the number of Document Sessions they establish with Zoho per month. The table below outlines the usage plans.   Plan Detail - Model ALevel 4                      Level 3Level 2Level 1FreeUsage [User Document Sessions]50,00025,00010,0005000300Full-featured EditingYesYesYesYesYesSSLYesYesYesYesYesDocument CollaborationYesYesYesYesYesAdditional Usage [User Document Sessions]5000500025001000Not available 2. Flat monthly fee model B : For partners/non-profits who provide their service/applications to users for a fee. The usage plans are similar to model A as indicated in the table, however the pricing level is higher. Plan Detail - Model BLevel 4                         Level 3Level 2Level 1FreeUsage [User Document Sessions]50,00025,00010,0005000300Full-featured EditingYesYesYesYesYesSSLYesYesYesYesYesDocument CollaborationYesYesYesYesYesAdditional Usage [User Document Sessions]5000500025001000Not available Note: For non-profits we do offer a discount and either Model A or B apply based on whether members are charged a fee or not for accessing the integrated Zoho services. This applies to organizations that offer services to members outside their own internal use. *Important Note: Partners who wish to include Zoho applications for both free as well as paid users must be on 'Model B' of the Remote API Pricing Plan. For pricing details, please contact: _______________________________________________________________________________________________________________________________________________ Commercial Program FAQWhat is a User Document Session [UDS]?-- A single document opened in Zoho service editor (e.g. Writer) equals "one user document session that is 1 UDS".How do I calculate my API Usage in terms of UDS (User Document Sessions)?-- The UDS counter is updated by 1 with every new request sent to Zoho for opening the document. So, if you open 5 different word documents (one at a time), it will be counted as 5 UDS. Similarly, a single document opened multiple times (say 5) will equal 5 UDS.To reiterate, the API usage depends on the number of requests sent to Zoho for opening the document. Each request is unique, valid for a single browser session and independent of other requests. Also, we do not count 'Save' as part of UDS count. You can do multiple save operations in a single document session.Sizing: How do I know how many User Document Sessions I need?On an average, we find that a percentage of users (maybe 10-15%) will regularly use an integrated Zoho service and of that portion, the number of User Document sessions falls into the categories we have provided in [...]

Remote-Editor-----Feature-Limitations :: Version2.4
The key advantages of using the Remote API includes the ability to remotely access the document Editors while storing the data back to your servers. However, the remote editors are not fully functional editors you can access from Due to the inherent limitations of no user account creation, they are a slightly scaled-down version of our online Editors with some features and functionality missing. The list of features that are not part of Zoho Services' Remote Editor is tabulated below:Zoho WriterZoho SheetZoho ShowDocument History & VersionsVBA MacrosAbility to Make Remote PresentationsDoc Roll: Listing public documents in your website or blogPublish Spreadsheets Duplicate a PresentationDigiSign: Ability to digitally sign Writer documentsInsert ButtonPresentation History & VersionsCustom DictionaryLinking External DataPublish PresentationsEmail as AttachmentCopy/Paste sheet from one Spreadsheet to anotherAdd TagsPublish Document Spreadsheet History, Versions & Audit TrailInsert Image from Picasa, Flickr, WebsearchSpreadsheet Settings (Locale Settings)Track ChangesLock Cells/SheetEquation EditorTab ColorsWatermarkLimit of 2 million cells per workbook; Maximum of 65536 rows or 256 columns per worksheetCheckoutZoho Forms usage[...]

Productivity-Apps-API :: Version1.6
Data APIs for Zoho Productivity Applications

In addition to providing solution for document & storage management needs, Data APIs are also available for Zoho's productivity applications including - Creator, Meeting, Projects, Reports & Invoice. Developers can make use of data stored in these Zoho apps for preparing to-do lists, querying database-driven web-applications, conducting web conferences etc.

This section provides links to the Data API specifications currently available for different Zoho productivity applications.
  • Zoho CRM API -- Allows third-party services to integrate CRM modules into their application. 

  • Zoho Creator API -- Allows external websites to collaborate with data-driven Zoho Creator applications, with ease. Developers can now build their web application in PHP, JSP, ASP, Perl or on any other programming language while the data gets stored in Zoho Creator.

  • Zoho Projects API -- Allows for a host of mashups as well as customized application development with the use of Zoho Projects data.

  • Zoho Reports API -- Allows hosted as well as in-premise applications to use Zoho Reports for specialized reporting and analysis.  With this API, applications can push data into Zoho Reports for reporting. The API also supports SQL Querying based on Zoho CloudSQL technology. 

  • Zoho Invoice API New* -- Serves as an interface for clients to integrate their applications with Zoho Invoice.

Zoho-API-Program---Overview :: Version3.1
Program Overview The Zoho family of APIs is an expanding portfolio of functionality and depth that provides partners and customers with a simple way to integrate several of Zoho's award-winning web applications into existing third-party applications, portals or websites. Some of the immediate benefits of API integration include: Ease of use and integration: the Zoho API's can be developed in PHP, Java and integrated into any type of application environment saving a lot of time and energy as well as eliminating risk associated with complex deployments. Extend the value and reach of your applications and services: Partners increase the value of their offering by combining the features and benefits of  integrated Zoho applications with  the services you already provide potentially increasing revenues and user retention. Data can be stored locally while applications are accessed in the "cloud" This concept is one of the biggest benefits of the program. Many users want to leverage the benefits of cloud computing but prefer to have their documents stored on their servers or on partners' servers Collaboration and Productivity: Many people want to collaborate online and do not like to open attachments, share files and manage several iterations of their documents. With the Zoho integration, users can open desktop documents in their browsers, invite participants to collaboratively edit and save a single copy of the document. The integrated Chat allows users to collaborate in real time while co-editing documents or using any of the other services. The following services are available through Zoho APIs: Zoho Writer: Word Processor Zoho Sheet: Spreadsheet Zoho Show: Presentations and Slideshows Zoho CRM: Online Customer Relationship Management Service Zoho Creator: Platform to Create Database Applications Zoho Reports: Reporting & Business Intelligence Service Zoho Projects: Online Project Collaboration & Management ToolZoho Invoice: Online Billing SoftwareZoho BooksNew*: Online Accounting SoftwareZoho PeopleNew*: Complete HR SolutionZoho RecruitNew*: Online Applicant Tracking System This section provides an overview of the different types of APIs and the various Zoho services that are available for integration in third-party applications. The overview also includes a summary of the API functionality. Zoho API Types There are two types of Zoho API each with a different set of functions and methods for data storage and account creation. The primary difference between the two is whether end user's data is stored on partner's servers or on Zoho servers. Remote API Data stored in partners' servers No login or User Account creation required in Zoho Data API  Data is stored in Zoho's document servers Users create and Zoho maintains a unique User ID Remote API - Brief OverviewThe Zoho office suite (Writer, Sheet and Show) provides some of the most advanced online productivity tools available today. The majority of our partner API implementations are of this type primarily because the office suite is so popular; everyone deals with documents in one format or another. The Remote API allows for partner & third-party applications to make use of the feature-rich editors of Zoho's Office applications (Writer, Sheet, Show) by providing a means for users to transparently upload their content from within the third party application, edit them, collaborate in real-time using the Zoho editors and then save the updated content back to their document servers. The key distinguishing factor of Zoho's remote API is that the data is totally under partner's control and the Zoho editor only provides an interface for editing the content and saving them back to the partners' specified location. The key difference with this approach and the Data API is that no user account is created in Zoho. In short, if you have a document management system of y[...]

Save-Document :: Version2.8
Save Notification Messagesnew*Saving Documents with Remote APIZoho Remote APIs allow partners and enterprises to save the document content back to their specified location through SaveURL method.Using Save URLA saveurl is nothing but a publicly accessible web url that fetches the content of the updated document from Zoho Document Server and saves it to the location specified in the enterprise document repository. Enterprises, who choose to save the document with the above method, should fulfill the below requirements :Enterprise remote servers need to expose one of their ports - port 443 (https) or port 80 (http) - from their location, for Zoho Services to push the data back. The saveurl value specified in the form submit need to be a proper domain name and publicly accessible over the web. Example : URL Workflow :Steps : Document Save & NotificationUser clicks on save button from Zoho Service editor.Zoho Document Server receives a save request from the Zoho editors. Zoho Document Server pushes the updated document content to the location specified in saveurl parameter. The partner's document management application in turn notifies the Zoho Document Server that save is successfully done.Document is saved back to partner's repository. Save Notification MessagesThe partner's application can customize the save notification message sent to Zoho Servers. The message is shown when the user saves the document from Zoho Service editor and handles both the save cases:Success Message (HTTP response code 200) - When the document is saved successfully Error Message (HTTP response code 500) - When the document save fails. The response to be sent to Zoho servers is of the format:RESPONSE: [Success or Failure Information message from the application]Note: In case the partner application fails to provide custom message of its own, Zoho will display its default save notification messages in the Service editors. The list of these messages is tabulated below:Save Notification MessagesDescriptionSave in ProgressUser clicks on Save button. A request for saving the document is initiated.Document Saved SuccessfullyDefault notification message displayed by Zoho when a document is saved successfully in partner's application. This message will appear when Zoho receives only a HTTP response code 200 without any custom message from the partner's application. Document already savedNo document modification detected. This message will appear in two cases:User hits the save button without modifying the contents of the original document.After getting the 'Document Saved Successfully' message, user inadvertently hits the save button without making any further edits to the document. Custom save notification message displayed when a document is saved successfully.This message is sent from the partner's application server with HTTP status code 200 and is of the format - RESPONSE: [Success Information message from the application] has saved the DocumentIn collaboration mode, Zoho notifies 'Document saved status' to other shared users.Problem in saving content. Please retain a local copy at your end and try again later.The save notification, sent as response, to Zoho servers from the partner application either fails or is null. HTTP status code is other than 200.Error in saving document from remote client sideDocument save fails. HTTP status code 500 returned to Zoho servers as a response with a custom message in the following format - RESPONSE: [Failure Information message from the application]Problem in saving complex document. Please retain a local copy at your end and try again later.This message is displayed when the user tries to save the document with null content into partner's application.Problem in posting the document. Please retain a local copy at your[...]

Form-Submit :: Version3.5
Form Submit (multi-part)In order to push the document from enterprise server and load it onto Zoho Services (Writer/Sheet/Show) editor, you need to submit a multi-part form-data to Zoho Services Grid with the following parameters. These parameters are common for all the three Zoho Services - Writer, Sheet and Show. Parameter Value Type Description content string Optional Actual content of the uploaded document. A new document will be created, if the content is empty. apikey string Mandatory Uniquely identifies the web-application in which the Zoho Service editors are integrated. output string Mandatory Determines the format in which the Zoho Service output will be sent.Possible values : view, editor, viewurl, urlDefault value : url filename string Mandatory Name of the document with proper file extension.Supported values for documents : doc, docx, rtf, odt, htm, html, txtSupported values for spreadsheets : xls, xlsx, ods, sxc, csv, tsvSupported values for presentations : ppt, pptx, pps, ppsx, odp, sxi lang string Optional Lang parameter enables each Zoho Service (Writer/Sheet/Show) to offer its remote editor interface in another language. Default value : en (English) For a full list of languages supported by Zoho Service remote editors, please click here. id string Mandatory Mandatory. Unique handback id or doc session id that integrators/users need to provide when sending request to Zoho for opening a particular document.  The 'id' parameter can be used to store all relevant document-related information, including session id, list of shared users, doc id etc. as an encoded string. The info in 'id' parameter will be returned to the 'saveurl' by Zoho Document Servers whenever 'save' is invoked by the user. Use-case: By providing shared user info in the 'id' parameter, a developer or a saveurl handler of the Zoho-integrated application will get to know which shared user has saved a document during collaboration. format string Mandatory The format in which the document needs to be saved back to the enterprise document repository.Supported values for documents : doc, docx, html, pdf, htm, odt, rtf, txt Supported values for spreadsheets : xls, xlsx, ods, sxc, csv, tsv, pdfSupported values for presentations : ppt, pptx, pps, ppsx, odp, sxiNote : The document can be pushed from enterprise server to Zoho Service editors in one format (say doc) and saved back to their original location in different format (say pdf). persistence(deprecated) boolean Optional persistence = true has been deprecated and the default value of this parameter is now set to false. This means, a copy of the document will temporarily reside on Zoho's document servers as long as you have the document open in Zoho editor. After you save & close the document session, the copy is automatically removed from Zoho's document servers.    saveurl* string Mandatory [Enterprise Server Web URL] - The saveurl is a publicly accessible web url which should be a service that fetches the content of the updated document from Zoho Document Servers and saves it to the location specified in enterprise document repository.Note : The saveurl, specified either over https or http url scheme, should be a public accessible, proper domain name with its port set to 443 or 80. Setting IP Addres[...]

Remote-API-Troubleshooting-Tips :: Version1.6
table { font-size: 10pt;}List of Developer FAQs for the Zoho IntegrationZoho Remote API allows for partners to create, edit and collaborate on their documents in Zoho's Office productivity service editors (Writer, Sheet, Show) while at the same time offering its partners to store and manage these documents on their own servers. With Zoho Remote API, you can:Create a new document, spreadsheet & presentation from your web applicationOpen existing documents.View and Edit documents based on the access privileges defined by the administrator of your web application.Collaborate on the documents in real-time.Save the document content back to your document servers.1. How do I open documents in Zoho Service Editors?Zoho Service Editors, exposed through Remote APIs, can be invoked by doing a simple HTTPs POST request to the specific Zoho Service URL. Depending on the file location, local drive or web, developers can send the request to Zoho Servers for opening the document in a couple of ways:Multi-part Form Submit - Open documents present in your computer's local drive or desktop.Normal Form Submit - Open documents present over a publicly accessible web url.As for sending request to Zoho Service URLs, developers can use the below links based on the file type (.doc, .xls, .ppt etc):Zoho Writer (document) - Sheet (spreadsheet) - Show (presentation) - Can I access my documents in Zoho Service Editors over secure connection (https)?Yes. For added assurance of accessing Zoho Services over a secure connection (https), developers need to pass an additional 'skey' parameter during form submit. The 'skey' value is associated with your 'api key' and can be obtained from the API Dashboard. You can log in from the API Sign-in page ( with your Zoho account credentials (username/password) to get the 'skey' details.Also, change the Zoho Service URL scheme to https when sending the form request. Example: I get an error while saving a document over https URL scheme. What am I doing wrong?The stated error in saving the document will occur in any of the below two cases:SSL Certificate does not match your registered domain name. Check the authenticity of your SSL Certificate from the website -'s SSL Certificate is not part of the Sun's JRE list supported by Zoho. List of supported CAs(Certification Authority) can be found here.4. How do I open document in different modes (view/edit) in Zoho Service Editors? There is a 'mode' parameter that determines the way in which the document is uploaded to Zoho Service Editors. Currently, Zoho allows four different values that can be passed in the mode parameter. They are -view -- Document opens in read-only mode.normaledit -- Document opens in edit mode exclusively for the particular user, no other collaborator is allowed for concurrent editing.collabview -- Document opens in collaborative view mode. Multiple users can view the contents of the document at the same time and can leave notes/comments using the integrated chat service. However, they cannot edit the document content.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.Note: It is mandatory to set the output parameter value as 'url' when mode is chosen as 'collabedit' during form submit.5. What is the use of 'output' parameter? How is it different from 'mode' parameter? The 'output' parameter decides the format in which output is sent from Zoho Servers. This is in response to the request sent by partners' server for opening the document. The response for the output could be either in 'url' o[...]

Doc-Content-APIs :: Version1.5
Document Content APIsThese apis are used to get content of a particular document, spreadsheet or a presentation associated with a Zoho account. It also includes shared and public documents. Request URI:Developers can send the request in the following URI format :Zoho Writer (Documents) :[documentid]?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI Zoho Sheet (Spreadsheets) :[bookid]?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI Zoho Show (Presentations) :[presentationid]?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI Access : private or publicFormat : xml, jsonHTTPs Method : GET Request Parameters Reference Parameter Value Description version scalar Optional. Get content of the document for a particular version. If no version is mentioned the last updated version content is displayed Document Content Methods : Method Name URI Request Description Content of an "owned" document Writer:[documentid]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet:[bookid]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show:[presentationid]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Get entire content of a particular document, spreadsheets or a presentation associated with a user's Zoho Account. Content of a "shared" document Writer:[shareddocumentid]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI  Show:[presentationId]?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI&sharedby=[usr]  Get entire content of a shared document, spreadsheet or a presentation associated with a user's Zoho Account. Note : For Zoho Show, it is mandatory to pass "sharedby" parameter. Content of a "public" document Writer:[publicdocumentid]?apikey=[APIKey] Sheet:[bookid]?apikey=[APIKey] Show:[presentationid]?apikey=[APIKey] Get entire content of a public document, spreadsheet or a presentation. Response Parameters ReferenceDocuments : Parameter Value Description content Displays the content of a document in HTML format. Spreadsheets : Parameter Value Description sheetContent Gets the entire content of a workbook. Multiple sheets are identified with their index parameter. Other parameters include name, rows and cols. row string Identifies a particular row with the index number and subsequent cell values in that row. cell string Gets content of each cell specific to each cell index. Other parameters may include dataType, value, formula etc. Presentation : Parameter Value Description presentationId integer Unique ID associated with each presentation. presentationName string Name of the presentation whose content is being listed. presentationNameUrl string UrlName associated with the particular presentation ownerName string Displays the Ema[...]

Data-API-Reference :: Version1.5
Data API Reference for DevelopersZoho provides REST style Data APIs which allows client applications to view a list of documents for a particular user, get the content of a document, edit them, upload/download document, grant/revoke sharing privileges for a document, tag documents in folders, and publish document for the external world. Thus, Data APIs provide an easy way to manipulate data and files stored in different Zoho Office productivity applications like Writer, Sheet and Show.Developers task have been made easier with the introduction of REST based Data APIs as it enables them to access all the document-related information by using a simple HTTP invocation. Using REST, developers can obtain domain specific data by pointing a URI to a specific location. In other words, developers can interact with a URI (e.g. through a pre-defined set of methods and receive standard HTTP responses in return. Now, let's have a detailed look at the REST request and response formats : REST Request Format :As discussed here, developers need to send two additional parameters, while sending the REST request. The parameters are "apikey" and "authtoken". Once the required parameters (apikey & authtoken) are obtained, developers can use the following URI format for accessing the Data API methods :[your_api_key]&authtoken=[your_auth_token]&scope=DataAPI Where :servicename: Name of the Zoho Service (Writer, Sheet or Show)possible values : "", "" & ""access: The access parameter can take two possible values - "private" and "public". URIs for manipulating user specific details start with "/api/private/".Example: To get a list of documents for a Zoho user, the URI "" can be usedURIs for getting public details, that are made available for everyone to view, start with "/api/public/" Example: To get a list of public spreadsheets in Zoho, the URI "" can be used. format: The format parameter takes two possible values : "xml" and "json". Depending on the format value specified in the request URI, Zoho will return either  XML or JavaScript Object Notation(JSON) as a response. HTTP calling conventions : GET and POSTFor "read operations", HTTP GET is used.For "write operations", HTTP POST is usedREST Response Format :Currently, Data APIs support the following response formats :XMLJSONJSONP (JSON callback)Response StructureThe response will have a  tag as the root node. It might either contain a or node as it's child, but not both. The node will be present under normal circumstances, whereas node will be present in case of error conditions.Thus, normal response will be of the form :      [specific XML response here] In case of error conditions - for example, referring to a document not present in Zoho Writer - the response will be of the form :[error code]     [Error Message] In the subsequent sections, we will be provide details of the different types of methods available for [...]

Document-List-APIs :: Version2
This topic is deprecated. Please access the new set of "Document List APIs" from over here: ""  Document List APIsThe document list apis, as the name suggests, is used to get a detailed list of all the documents, presentations & spreadsheets associated with a particular Zoho Account. This also includes particulars of a list of shared, trashed and public documents present in a user's account. Request URI:Developers can send the request in the following URI format :Zoho Writer (Documents) :[API Key]&authtoken=[AuthToken]&scope=DataAPI Zoho Sheet (Spreadsheets) :[API Key]&authtoken=[AuthToken]&scope=DataAPI Zoho Show (Presentations) :[API Key]&authtoken=[AuthToken]&scope=DataAPI Access : private or publicFormat : xml, jsonHTTP Method : GETRequest Parameters Reference Parameter Value Description start-from integer Optional. Sets the initial document number from which the documents will be listed. If there are 10 documents and start-from value is set to 3, then the documents will be listed from the 3rd document. limit integer Optional. Sets the number of documents to be listed. If the limit value is set to 5 then the number of documents listed is 5. order-by string - (createdTime | lastModifiedTime | name) Optional. Order documents by createdTime, lastModifiedTime & document name. sort-order string - (asc | desc) Optional. Arrange the workbooks in ascending or descending order. Default sorting is done in descending order. Document List Methods : Method Name URI Request Description List all documents Writer:[APIKey]&authtoken=[AuthToken]&scope=DataAPISheet:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Lists all the documents, spreadsheets and presentations associated with a user's Zoho Account. List all "shared" documents Writer:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Lists all the documents, spreadsheets and presentations that have been "shared" to a user's Zoho Account. List all "trashed" documents Writer:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Lists all the documents, spreadsheets and presentations that have been "trashed" from a user's Zoho Account. List of public documents for a Zoho Account Writer:[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet: https://sheet.zoho[...]