After using the ticket in your application and if the ticket is not further needed in your application, then it is mandatory to invalidate the ticket (logout the session) using LOGOUT API which is discussed in the below topic.

To Logout (Invalidate the ticket) from the session:

To logout (Invalidate the ticket) from the current session in your application, you need to send a HTTPS POST request as follows. It is mandatory to invalidate the ticket once the ticket usage is completed in the application.

<form method="POST" action="https://accounts.zoho.com/logout" target="_self">
<input type="hidden" name="ticket" value="ticket_value">
<input type="hidden" name="FROM_AGENT" value="true">
<input type="submit">
</form>

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

Ticket Expiry:

The ticket that you generate will be valid for 7 days from the date on which it is generated. Subsequently, if you use the same Ticket in the API calls it will throw an error message. Hence you need to ensure you renew the ticket atleast once every 7 days in your application for using the Zoho Reports API. 

You can find out whether the ticket has expired through the following means

• When you invoke any API through the old ticket it will throw an HTTP 400 error
• The server will return a error response. The example format of the error message returned for a ADDROW api call is given below

Error Format is JSON:

{
 
   "response":{
   "uri":"/api/zoho_username/zoho_dbname/zoho_tablename",
   "action":"ADDROW",
   "error":{
     "code":8518,
     "message":"You need to (re)login to perform this operation"
   }
 }
}

Error Format is XML:

<response uri="/api/senthilvel.n/testingapi/testTable2" action="ADDROW">
      <error>
            <code>8518</code>
            <message>You need to (re)login to perform this operation</message>
      </error>
</response>

If you receive a error response like the above, parse the response to get the error code and check whether it is equal to the invalid ticket error code "8518" (or) "7309". This confirms that the Ticket has expired (session expired). You need to generate a new ticket by calling the Ticket generation API again to further call other Zoho Reports API methods.

We suggest you to parse the error response from our server and regenerate the ticket if  "invalid ticket" error thrown by our server (i.e in case of ticket expiry / session logged out).

Important Note:

• You are strongly recommended not to generate API ticket for every API request. You can use the same ticket in your application for 7 days without any issues.