Configuration - OAuth

oauth_configuration.properties

OAuth Configuration file containing information about the necessary client id, secret, access type, etc. Those are all available when you register the app with Zoho. There are also some additional information that the file needs. The file must be in the below shown format with the following properties & their respective values. 

• client_id , client_secret and  redirect_uri  are your OAuth client’s configurations that you get after registering your Zoho client.
  


• scope can be one or many (comma separated) valid Zoho CRM scopes. Add  Aaaserver.profile.Read scope along with your other required scopes. It is mandatory.
  


• access_type can be set to offline or online.
  


• persistence_handler_class is your implementation of the ZohoPersistenceHandler interface, which has handler methods to store OAuth data. This is discussed in the next section.
  
  For example: persistence_handler_class=com.zoho.oauth.clientapp.ZohoOAuthFilePersistence (or) com.zoho.oauth.clientapp.ZohoOAuthDBPersistence (or) your own persistence handler class.
  


• If you prefer to use our DB persistence ( ZohoOAuthDBPersistence.java ) , you need to give the mysql_username and mysql_password keys for mysql connectivity. 
  
  • By default, mysql_username = root and mysql_password = . 
    
  • The tokens are generated and placed in the database table automatically(which is explained in the ZohoOauthDBPersistence section) once the authentication process is complete. 
    
  
   
• In case you're using the File Persistence, the oauth_tokens_file_path  is the relative path to a property file " oauthtokens.properties " that contains the access tokens, refresh tokens etc. The file needs to contain the following properties.
  

Configuration - ZCRM

SDK also provides options to override certain HTTP request attributes. These configurations should be provided in this file. Create a similar property file,

zcrm_configuration.properties

The file must be in the below shown format with the following properties & their respective values. 

minLogLevel=
currentUserEmail=
domainSuffix=
accessType=

• minLogLevel  value represents the minimum log level for the logger prints of SDK. The supported values are ALL, TRACE, DEBUG, INFO, WARNING, ERROR and OFF. The default minimum log level is WARNING.
  


• If you are serving multiple users, to allow SDK to identify the specific user who requests, the requester's email address should be set through the following code snippet before making the actual method call of the SDK.
  ZCRMREstClient.setCurrentUser(currentUserEmailId);


• On the other hand if it is a single user, you can either set the user's email id in ZCRMRestClient (as the one shown above) for every request or you may give the user's email id in  zcrm_configuration.properties  file with the key  currentUserEmail  as a one time configuration.
  


• domainSuffix  (optional) - Multi DC support. 
  
  • us - www.zohoapis.com 
    
  • eu - www.zohoapis.eu 
    
  • cn - www.zohoapis.com.cn 
    


• accessType  (optional) - Type of environment in CRM
  
  
  
  • Production  - Environment that has active paying users accessing critical business data. 
    
  • Development  - Environments where you can extend, integrate and develop without affecting your production environments. 
    
  • Sandbox  - Environments specifically used for testing application functionality before deploying to production or releasing to customers. 
    
  
  

Once both the configuration files are set, you can proceed to procure grant, access and refresh tokens for your application.