An open API service indexing awesome lists of open source software.

https://github.com/ahmader/node-zoho

Zoho API access for NodeJS
https://github.com/ahmader/node-zoho

zoho zoho-crm zoho-crm-api

Last synced: about 2 months ago
JSON representation

Zoho API access for NodeJS

Awesome Lists containing this project

README

          

Zoho CRM API REST wrapper for node.js

[![Build Status](https://travis-ci.org/ahmader/node-zoho.png?branch=master)](https://travis-ci.org/ahmader/node-zoho)
[![NPM version](https://badge.fury.io/js/node-zoho.png)](http://badge.fury.io/js/node-zoho)
[![Code Climate](https://codeclimate.com/github/ahmader/node-zoho.png)](https://codeclimate.com/github/ahmader/node-zoho)
[![Stories in Ready](https://badge.waffle.io/ahmader/node-zoho.png?label=ready&title=Ready)](https://waffle.io/ahmader/node-zoho)

Supports:
- [Zoho CRM API Version 1.0 (EOL)](http://www.zoho.com/crm/help/api/api-methods.html)

Currently a WIP, but feel free to ask how you can help.

## CRM Modules Support:



Method Name
Leads
Accounts
Contacts
Potentials
Events
Tasks
Notes


insertRecords






convertLead

NA
NA
NA
NA
NA
NA

getRecordById






NA

getDeletedRecordIds






NA

getMyRecords






NA

getRecords






NA

updateRecords






NA

searchRecords






NA

getSearchRecords






NA

getSearchRecordsByPDC






NA

deleteRecords






getRelatedRecords






getFields






updateRelatedRecords
NA
NA
NA
NA
NA
NA
NA

uploadFile






NA

downloadFile






NA

deleteFile






NA

uploadPhoto

NA

NA
NA
NA
NA

downloadPhoto

NA

NA
NA
NA
NA

deletePhoto

NA

NA
NA
NA
NA

delink
NA
NA
NA
NA
NA
NA
NA

getUsers
NA
NA
NA
NA
NA
NA
NA

getModules
NA
NA
NA
NA
NA
NA
NA

# Example of use

```
var Zoho = require('node-zoho');

var zoho = new Zoho({authToken:'API-TOKEN'});
var records = [
{
"Lead Source" : "Site Registration",
"First Name" : "Test",
"Last Name" : "Testerson",
"Email" : "test@testerson.com",
}
];

zoho.execute('crm', 'Leads', 'insertRecords', records, callback);

// to pass optional parameters
zoho.execute('crm', 'Leads', 'insertRecords', records, {wfTrigger: true}, callback);

var callback = function (err, result) {
if (err !== null) {
console.log(err);
} else if (result.isError()) {
console.log(result.message);
} else {
console.log(result.data);
}
}

```

# Contribute

All the code is coffescript, but we deploy compiled js to npm. If you want to help, checkout the git repo and submit a PR.

# Release instructions

1. Wait for TravisCI confirmation that latest merge passes tests.
2. Run `grunt release`. This bumps the package.json version, creates npm-shrinkwrap.json, tags this version and pushes it.
3. `npm publish` will compile the CoffeeScript and push the latest version to npmjs.org

[![NPM](https://nodei.co/npm/node-zoho.png?downloads=true)](https://nodei.co/npm/node-zoho/)

[Zoho CRM API Version 1.0 (EOL)](http://www.zoho.com/crm/help/api/api-methods.html)