Zoho Writer
Home   Download  Email This Page  




Blogs  Forums  Creator Home Toll Free : 888 900 9646


Zoho Creator API - CSV Format


 Zoho Creator provides Web APIs in CSV format which allows client applications to add, delete, update and view records on their applications created with Zoho Creator. The calling conventions employed over here for these APIs is HTTP POST . In return the user gets a formatted XML response from the called method.



API URL


For accessing the Zoho Creator API the users need to pass a couple of additional query parameters. These parameters are:
  • API Key
  • Ticket
Please refer here on the process of getting the ' API Key ' and ' Ticket '. Once the requisite API Key and Ticket is acquired, the users should use the following format mentioned below to access the API methods:


For Read Operations:

http://creator.zoho.com/api/csv/ read /apikey=[API Key]&ticket=[Ticket]


For Write Operations:

http://creator.zoho.com/api/csv/ write /apikey=[API Key]&ticket=[Ticket]



Request Format


The HTTP POST method is used for both read and write operations.

For write operations the POST request will be in the following format:

<form method=" POST " action="http://creator.zoho.com/api/csv/ write /apikey= [APIKEY] &ticket= [Ticket] ">
<input type="hidden" name="CSVString" value=" CSV String with request parameters in the specified format ">
<input type="submit" value="Sumit CSV String">
</form>


For read operations the POST request will be in the following format:

<form method=" POST " action="http://creator.zoho.com/api/csv/ read /apikey= [APIKEY] &ticket= [Ticket] ">
<input type="hidden" name="CSVString" value=" CSV String with request parameters in the specified format ">
<input type="submit" value="Sumit XML String">
</form>


The request parameters comprises of comma seperated values. The request format will vary depending upon the type of operation being performed and is specified in the CSV - RPC API Reference section.


Response Format


The response will be in CSV format. The response will vary depending upon the operation being performed. For example, the response parameters to view records in an application comprises of form name, criteria, status and the record values that match the specific criteria, as given below: 



                     Form Name , Criteria , Status
                     

                     dateForm ,Age EQUAL 24 ,Success
                     

                     ID ,Name ,Age ,DOB
                     

                     2000000079003 ,Kalai ,24 ,2007-08-20 00:00:00.0


If there is an error in the request format, the corresponding error code with the error message will be displayed as status.



API Reference

Once you login to your application, use the link http://creator.zoho.com/api/reference to view the list of applications, the forms and fields in the application and the deluge field names, as shown in the screen-shot given below. This link enables you to easily refer the form names, deluge field names and the picklist values while formating your request.



Error Codes and Messages

The list of HTTP error codes displayed by the Zoho Creator api and their description is given here .



Getting Started

To get started with the CSV - RPC APIs, please refer our CSV-RPC API Reference.




0 Comments