Reports Help

Prerequisites for using the API

Important Note:

  1. It is mandatory to use HTTPS in all API requests instead of HTTP request. HTTP is not supported.
  2. Always use https://reports.skydesk.jp as the API request URL.

Users have to full fill the below given prerequisites to use SkyDesk Reports API

SkyDesk Reports User Account

Users should have a valid SkyDesk Reports login id 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 SkyDesk Account. This is a user-specific and permanent token, that need to be passed along with every SkyDesk Reports API request.

Deprecation Note

  1. It is no longer mandatory to pass the ZOHO_API_KEY parameter as part of the query string in the URL. This will be deprecated soon. In case you are using it, you can remove it. 
  2. Usage of Ticket in API requests is deprecated. Users are strongly recommended to use Auth Token instead of Ticket in your API requests, as support for Ticket will be removed in the near future.
  3. Recommended to use SkyDesk Reports Login Email Address in the API URL instead of SkyDesk Username.

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.

API Mode

To generate Auth Token using API mode, send an HTTPS POST request to SkyDesk Accounts using the following URL format.

URL Format:

https://accounts.skydesk.jp/apiauthtoken/nb/create?SCOPE=SkyDeskReports/reportsapi

Mandatory POST Parameters to be passed along with this URL are:

Parameter Description
EMAIL_ID Specify your SkyDesk Login Email Address
PASSWORD Specify your SkyDesk Reports Password

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 SkyDesk Reports API access.
  • RESULT
Value is TRUE if the Auth Token is generated successfully.

 

Browser Mode

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

  1. Login to your SkyDesk Reports account.
  2. Now open a new tab in the same browser and then access the url below.
https://accounts.skydesk.jp/apiauthtoken/create?SCOPE=SkyDeskReports/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 SkyDesk 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 SkyDesk account from the SkyDesk Account page.

To access the active Auth Tokens:

  • Login to SkyDesk Reports.
  • Click the drop-down menu displayed with your user name at the top right corner.
  • Click Account Settings menu item, this will open SkyDesk Accounts Profile page (You can also directly access/open this page using direct link https://accounts.skydesk.jp ).
  • 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 SkyDesk services (For example the Auth Token generated for SkyDesk Reports cannot be used in another service like SkyDesk CRM and vice versa).
  • 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.
  • You can generate any number of Auth Tokens for each of the SkyDesk service.

Workspace

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

Top