Accessing Zoho APIs

Tags:  

Accessing Zoho APIs


Users need an API Key as well as Ticket ID for accessing Zoho APIs. We use the API key to track usage whereas the Ticket ID is required for authenticating the user for a particular Zoho service.

How to request for an API Key ?

Users can request for the API Key by registering themselves at the following : http://writer.zoho.com/apikey.htm. Upon receiving the request, Zoho will send the API Key to the Email ID that the user has specified during registration process. Getting this API Key is a onetime process.


Note : Please do not distribute or use the key for creating multiple services (you should request an API key for each individual service that you plan to create). Any violations will result in the cancellation of the API Key.

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 HTTP POST method only) in the following URL format:

Request:


HTTP URL = https://accounts.zoho.com/login

POST Parameters :

Parameter Name
Description
LOGIN_ID
Users' Zoho ID or Email ID
PASSWORD
Password for the Zoho ID
FROM_AGENTvalue should be true
servicename
possible values - ZohoWriter, ZohoShow, ZohoSheet, ZohoCreator, ZohoReports,AaaServer, ZohoProjects.

 

Note : The parameter names passed in POST request are case-sensitive.

Sample form for generating Ticket ID :

<form method="POST" action="https://accounts.zoho.com/login " target="_self">

<input type="hidden" name="LOGIN_ID" value="[ZOHO ID or Email ID]">

<input type="hidden" name="PASSWORD" value="[Passoword for ZOHO ID]">

<input type="hidden" name="FROM_AGENT" value="true">

<input type="hidden" name="servicename" value="ZohoWriter">

<input type="submit" value="Get Ticket ID" class="divbutton" name="submit">

</form>


Depending on the parameters passed over the requested URL, the user will get a response in the following name/value format:

Response:


#Thu Oct 26 02:17:49 PST 2006
WARNING=
TICKET=543754375sdferuecmvc458545432dfffqq
RESULT=TRUE


Response Details:
  • #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.
Note : Ticket, generated once, is valid for 7 days.


 RSS of this page