API Docs
/
No Results Found
Authentication

Authentication

All Zoho Expense APIs need to be authenticated using an oauth token.

OAuth 2.0 is an open authorization protocol which grants third party applications limited access to user accounts on an HTTP service. The authentication and authorization process is facilitated only between the end-user and the HTTP service. Zoho APIs use OAuth 2.0 to provide dependable security for your application data. OAuth 2.0 delegates authorization and authentication for web and desktop applications, and mobile devices.

You can obtain an OAuth token by following the steps mentioned below:

  1. Register your application
  2. Get an authorization grant
  3. Get an access token

1. Register your application

Before integrating Zoho APIs with your application using OAuth, you must register your application with Zoho. This can be done through the developer console of your Zoho account, where you will have to provide details regarding your application like Name , Website , Redirect URI, or Callback URL. Once the authorization is approved or denied, the user will be redirected to the callback URL specified at the time of registration.

Once your application is registered, the service will issue a client ID and a client secret. The Client ID is used by Zoho to verify the identity of the application and has a public visibility. The Client Secret is used to authorize the appropriate resources that can be accessed by the authenticated application. The Client Secret will be known only to Zoho APIs and the authenticated application.

2. Get an authorization grant

URL: https://accounts.zoho.com/oauth/v2/auth

Params:

  • scope=<Scopes for which token to be generated> Eg : ZohoExpense.expensereport.READ,ZohoExpense.advance.CREATE
  • client_id=<The client ID of the integrating app>
  • state=<An opaque string, it will returned as a URI parameter>
  • response_type=code
  • redirect_uri=<https://app.example.com/oauth (Redirect URI of your choice)>
  • access_type=offline (The allowed values are offline and online)

Available Scopes:

Scopes Scope operations available
all ZohoExpense.fullaccess.ALL
Show Action
expensereport ZohoExpense.expensereport.UPDATE, ZohoExpense.expensereport.READ, ZohoExpense.expensereport.CREATE, ZohoExpense.expensereport.DELETE
Show Action
approval ZohoExpense.approval.CREATE
Show Action
reimbursement ZohoExpense.reimbursement.CREATE
Show Action
advance ZohoExpense.advance.UPDATE, ZohoExpense.advance.CREATE, ZohoExpense.advance.DELETE
Show Action
users ZohoExpense.users.UPDATE, ZohoExpense.users.CREATE, ZohoExpense.users.DELETE,ZohoExpense.users.READ
Show Action
settings ZohoExpense.orgsettings.UPDATE, ZohoExpense.orgsettings.CREATE, ZohoExpense.orgsettings.DELETE,ZohoExpense.orgsettings.READ
Show Action

Sample Response

On calling the API, it will redirect to the redirect uri given with the authorization grant appended to it like below:
https://app.example.com/oauth?state=tempstate&code=1000.47b8fa1a1676bda5da938decdf0cf0d6.d3f48797707de05fcac81d135dc7b6c0

3. Get an access token

After getting the authorization grant, post it to the below API to get the access token and the refresh token.

URL: https://accounts.zoho.com/oauth/v2/token

Params:

  • code=<Code obtained in the above step>
  • client_id=<The client ID of the integrating app>
  • client_secret=<Obtained during Client Registration>
  • redirect_uri=<Same URI that was used in the above step>
  • grant_type=authorization_code

Note: expires_in parameter in response contains expiry time of access_token in milliseconds.

Regenerating the access token with the refresh token

Once the access token has expired, it can be regenerated from the refresh token by making POST call to the API given below.

URL: https://accounts.zoho.com/oauth/v2/token

Params:

  • refresh_token=<Refresh Token obtained in the above step>
  • client_id=<The client ID of the integrating app>
  • client_secret=<Obtained during Client Registration>
  • redirect_uri=<Same URI that was used in the above step>
  • grant_type=refresh_token

Revoking a Refresh Token

A Refresh Token can be revoked by calling the API given below.

URL: https://accounts.zoho.com/oauth/v2/token

Params:

token = <Refresh token>

Sample Response

{ "access_token": "1000.c656b09869cfef3be0ca145e44143fa9.a11f43090a54d71dc0797ec92bf34b9e", "refresh_token": "1000.4038qw5a8a5af1234ce920a45sx388a6.a450db33ca9e80701b1a23c8fe98e62e", "expires_in_sec": 3600, "api_domain": "https://www.zohoapis.com", "token_type": "Bearer", "expires_in": 3600000 }

Sample Response

{ "access_token": "1000.e896b09869afef6be0ca145e44143fa9.a78f43090a54d71dc0797ec92bg44b9e", "expires_in_sec": 3600, "api_domain": "https://www.zohoapis.com", "token_type": "Bearer", "expires_in": 3600000 }

Sample Response

{"status":"success"}