passport-Zoho CRM

Passport strategy for authenticating with Zoho CRM using the OAuth 2.0 API.

This module lets you authenticate using Zoho CRM in your Node.js applications. By plugging into Passport, Zoho CRM authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-zoho-crm

Usage

Create an Application

Before using passport-zoho-crm, you must register an application with Zoho CRM. If you have not already done so, a new application can be created at developer applications within Zoho's settings panel. Your application will be issued a client ID and client secret, which need to be provided to the strategy. You will also need to configure a authorized redirect URL (ie, callback URL) which matches the route in your application.

Note: Don't use hyphens in your client domain while registering your application on Zoho CRM's developer console. If you have an invalid URL, it will throw an error as follows: Error Occured

Configure Strategy

The Zoho CRM authentication strategy authenticates users using a Zoho CRM account and OAuth 2.0 tokens. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the access token and optional refresh token, as well as profile which contains the authenticated user's Zoho CRM profile. The verify callback must call cb providing a user to complete authentication.

var ZohoCRMStrategy = require('passport-zoho-crm').Strategy;

passport.use(new ZohoCRMStrategy({
    clientID: ZOHOCRM_CLIENT_ID,
    clientSecret: ZOHOCRM_CLIENT_SECRET,
    redirect_URL: "http://127.0.0.1:3000/auth/zohocrm/callback"
    scope: 'ZohoCRM.modules.READ',
    response_type: 'code',
    access_type: 'offline'
  },
  function(accessToken, refreshToken, profile, cb) {
    // ...
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'zoho-crm' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/zohocrm',
  passport.authenticate('zoho-crm'));

app.get('/auth/zohocrm/callback', 
  passport.authenticate('zoho-crm', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

Examples

For a complete, working example, refer to the (WIP) login example.

Contributing

Tests

The test suite is located in the test/ directory. All new features are expected to have corresponding test cases. Ensure that the complete test suite passes by executing:

$ npm install --dev
$ make test

Coverage

The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing: