Analytics-Plus Help

Prerequisites for using the API


 

1. It is mandatory to use HTTPS in all API requests instead of HTTP request. HTTP is not supported

2. Always use https://<reports-hostname>:<port>/api/<reports-loginname>/<databasename>/<tablename> or<reportsname>

 as the API request URL.

The following are the prerequisites to use Zoho Reports API.

ManageEngine Reports user account

Auth Token

  • Generating Auth Token
  • Managing Auth Tokens

workspace

ManageEngine Reports User Account

Users should have a valid ManageEngine login email address to use the API. 

Auth Token

Authentication Token, here after referred as Auth Token, is a unique token that authenticates the user to access the ManageEngine Account. This is a user-specific and permanent token, that need to be passed along with every ManageEngine Reports API request.

Generating Auth Token

Users can generate a Auth Token using one of the following mode. You can generate it just once and use it for all your API calls.

  • Browser Mode
  • API Mode
     

Browser Mode

To generate Auth Token from your Browser, follow the steps given below. 

  1. Login to your ManageEngine Reports account.
  2. Now open a new tab in the same browser and then access the url below.
https://<hostname>:<accounts_port>/apiauthtoken/create?SCOPE=ZROP/reportsapi

Sample Response:

The following is a sample response for a Auth Token request. 

#
#Wed Jun 29 03:07:33 PST 2013
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30
RESULT=TRUE

Response Details:

  • #COMMENT
Auth Token generated date.
  • AUTHTOKEN

The permanent Auth Token (Alpha numeric value) generated for ManageEngine Reports API access.

  • RESULT

Value is TRUE if the Auth Token is generated successfully.

 

Note for users using Two Factor Authentication:

If you have enabled Two Factor Authentication(TFA) for your ManageEngine Account, then you need to specify the Application Specific Password, instead of your ManageEngine Reports account password, to generate the Auth Token. 

The following are the steps to generate an Application Specific Password for your ManageEngine Account.

  1. Login into ManageEngine Account. 
  2. Click Two Factor Authentication. The Two Factor Authentication section in the Settings page will open.
  3. Click Manage Application Specific Passwords button.
  4. Specify a descriptive name in Device (or) App Name field. For example ManageEngine Reports API. The Device (or) App Name is only for your reference.
  5. Specify your ManageEngine Reports Account Password.
  6. Click Generate. The Application Specific Password will be generated.


Use this Application Specific Password to generate the Auth Token for your account. Learn more about the Application Specific Passwords from here.

Sample Response:

The following is a sample response for a Auth Token request. 

#
#Wed Jun 29 03:07:33 PST 2013
AUTHTOKEN=bad18eba1ff45jk7858b8ae88a77fa30
RESULT=TRUE

Response Details:

  • #COMMENT
Auth Token generated date.
  • AUTHTOKEN

The permanent Auth Token (Alpha numeric value) generated for ManageEngine Reports API access.

  • RESULT

Value is TRUE if the Auth Token is generated successfully.

 

Managing Auth Tokens

You can access and manage all the active secret Auth Tokens of your ManageEngine account from the ManageEngine Account page. 

To access the active Auth Tokens:

  • Login to ManageEngine Reports.
  • Click the drop-down menu displayed with your user name at the top right corner.
  • Click Account Settings menu item, this will open ManageEngine Accounts Profile page 
  • Navigate to the Settings tab and then click Active Authtokens. The Active Authtoken page will list all the active secret Auth Token of your account.
  • If required, you can remove or regenerate the Auth Token using the Remove and Re-Generate button respectively. 

 


Important Note

 

  • The Auth Token is a service-specific token and cannot be interchanged among ManageEngine services
    (For example the Auth Token generated for ManageEngine Reports cannot be used in another service like ManageEngine CRM and vice versa). 
  • Generate a single Auth Token and use it across all API calls in ManageEngine Reports.
  • In case the user has removed or regenerated the Auth Token, then the existing token will become invalid and cannot be used in API request. 
  • In case the user is deactivated, then all the Auth Token's of the user's account will become invalid.
  • Google Apps User can log into your ManageEngine Reports account and then use the browser mode to generate the Auth Token.

 

workspace

To use the ManageEngine Reports API, users should have already created a workspace with required tables and reports in ManageEngine Reports service using the browser based Web interface provided. You cannot use the API, if there are no workspaces available in your ManageEngine Reports account. 

 

Share this post : FacebookTwitter