Creator API

Generate Auth Token

URL Format

To generate the Auth Token, you need to send an authentication request to Zoho Accounts using the URL format below.

API Mode

https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCreator/creatorapi&EMAIL_ID=Zoho CREATOR Username or Email ID&PASSWORD=Zoho CREATOR Password

Browser Mode

https://accounts.zoho.com/apiauthtoken/create?SCOPE=ZohoCreator/creatorapi

Note:

  • Google Apps users will have to use the browser mode to generate the auth token.
  • You should be logged in to your account to generate the Authentication Token using the browser mode.

Parameters

Parameters to be passed along with this URL are:

Parameter Name Description
EMAIL_ID Specify your email address
scope Specify the value as ZohoCreator/creatorapi.
PASSWORD Specify your Zoho Creator password.

Sample Response

#
#Wed Feb 29 03:07:33 PST 2012
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30
RESULT=TRUE

Note:

  • The Authentication Token can be used in all your API calls. Please keep a note of the generated Authentication Token as it will not be displayed in the Creator API page.

Important Notes

  • The Authentication Token is user-specific and is a permanent token.
  • The Authentication Token of a user's account will become invalid if the user is deactivated.
  • It is recommended that you note down your Authentication Token.
  • Access and manage all the active secret auth tokens of your account by selecting Settings -> Active Authtokens in https://accounts.zoho.com

Important Note for Existing API Users

If you are an existing Developer API user and you are using the API ticket and apikey for all your API calls, it is recommended that you replace those URLs with the Creator Authentication Token. We will not be supporting the API ticket and apikey after 3 months. We will keep you posted of the exact date.

How do I generate Auth Token for Google Apps login?

By signing in with Google Apps, you don't actually set a password with Zoho. So you need to set one up. After logging in to your account, note your username in the top-right corner. This is your username and you'll use it on the zoho.com domain. So if your username is 'john_mathew' then you're email should be john_mathew[at]zoho[dot]com.

Click your username and choose "My ZoHo Account" from the dropdown. On the new window select 'Change Password'. You'll have a note that you login from Google, yahoo, etc... and if you want to set a password to click the link. It will send you a link via email. Follow the instructions in the email to set your password. For example, NewPassword123.

You can now use this username and password, or your google apps authentication to log in. To get a token, follow the steps below:

https://accounts.zoho.com/apiauthtoken/nb/create?SCOPE=ZohoCreator/creatorapi&EMAIL_ID=john_mathew@zoho.com&PASSWORD=NewPassword123

How do I benefit from using the Auth Token?

The Auth Token is permanent and unlike the API Ticket, you DO NOT have to generate a new token every 7 days.

How do I replace the API Key and Ticket with the Authentication Token?

Sample request using apikey and ticket to add records ( REST API )

<form method="POST" action=https://creator.zoho.com/api/xml/sample/Employee/add/>
<input type="hidden" name ="apikey" id="apikey" value="************">
<input type="hidden" name ="ticket" id="ticket" value="************">
<input type="text" name="Name" value="Gary">
<input type="text" name="DOB" value="12-Jun-1980">
<input type="text" name="Address" value="USA">
<input type="text" name="Basic" value="10000">
<input type="text" name="Hobbies" value="Reading,Writing">
<input type="submit" value="Add Record">
</form>

Sample request using auth token and scope to add records ( REST API )

<form method="POST" action=https://creator.zoho.com/api/xml/sample/Employee/add/>
<input type="hidden" name ="authtoken" id="authtoken" value="bad18eba1ff45jk7858b8ae88a77fa30">
<input type="hidden" name ="scope" id="scope" value="creatorapi">
<input type="text" name="Name" value="Gary">
<input type="text" name="DOB" value="12-Jun-1980">
<input type="text" name="Address" value="USA">
<input type="text" name="Basic" value="10000">
<input type="text" name="Hobbies" value="Reading,Writing">
<input type="submit" value="Add Record">
</form>

Top