Zoho CRM API is available for all editions, Free (Single or Three
Users), Professional, and Enterprise. You can request for the API Key
from your CRM account and the key will be generated automatically in
your CRM account. Please make sure that you have permission to access
the API service. If you don't have permission, please contact your CRM
administrator.
To generate API key
- Log in to Zoho CRM with Administration privilege.
- Click on the Setup > Admin Settings > Generate API Key link.
Generate Ticket
To generate the ticket ID, send the authenticated request to Zoho Accounts server over a secured connection as given below:
Request
https://accounts.zoho.com/login?servicename=[ZohoCRM]&FROM_AGENT=true&LOGIN_ID=[Zoho
Username/Email Address]&PASSWORD=[Password]
The mandatory parameters along with their values to be passed in the URL are:
| Parameter |
Type |
Description |
| servicename |
ZohoCRM |
Specify the service name is ZohoCRM |
| FROM_AGENT |
Boolean |
True |
| LOGIN_ID |
String |
User's Zoho ID or Email ID |
| PASSWORD |
String |
Password for the Zoho ID |
Response
Depending on the parameters passed over the requested URL, you will get a response in the format given below:
| Parameter |
Type |
Description |
| Comment |
String |
Ticket generated date & time |
| WARNING |
String |
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 |
String |
Ticket generated for the request |
| RESULT |
Boolean |
Value is TRUE if the ticket is generated successfully, else it is FALSE. |
Important Note: Your API
ticket is valid for 7 days. After 7th day, you must generate a new
ticket to work with Zoho CRM - API service. If you are not updating the
application with a new ticket ID, you will receive 4834 - Invalid Ticket ID error response from API request.
Related Topics
