Skip to content

Fixed some typos in README #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed some typos in README #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
##Node JS SDK for Zoho CRM
## Node JS SDK for Zoho CRM

##Abstract
## Abstract

Node SDK is a wrapper for Zoho CRM APIs. Hence invoking a Zoho CRM API from your Node application is just a function call which provide the most appropriate response.

This SDK supports both single user as well as multi user authentication.

##Registering a Zoho Client
## Registering a Zoho Client

Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register your client app with Zoho. To register your app:

Expand All @@ -24,19 +24,21 @@ Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register

- The newly registered app's Client ID and Client Secret can be found by clicking Options → Edit.
(Options is the three dot icon at the right corner).

##Installation of Node CRM SDK
## Installation of Node CRM SDK

Node JS SDK will be installed and a package named 'zcrmsdk' will be created in the installation directory.

>npm install zcrmsdk
```
npm install zcrmsdk
```

Once installed it can be used in the code as below,

>var ZCRMRestClient = require('zcrmsdk')

##API Usage
## API Usage

##Configurations
## Configurations

Your OAuth Client details should be given to the SDK as a property file. In the SDK, you need to configure a file named oauth_configuration.properties. Please place the respective values in that file. You can place it under resources/ package from where the SDK is used.

Expand Down Expand Up @@ -129,7 +131,7 @@ Each time server is restarted, this function has to be called and both the confi
**All functions return promises in zcrm node sdk.**


##Initialize
## Initialize

Below snippet has to be called before starting the app

Expand Down Expand Up @@ -158,7 +160,7 @@ ZCRMRestClient.generateAuthTokens(user_identifier,grant_token).then(function(aut

```

##Generating access token from refresh token
## Generating access token from refresh token

This will be handled by sdk itself if the access and refresh token is generated by sdk.Developer need not call this explicitly.

Expand All @@ -173,7 +175,7 @@ ZCRMRestClient.generateAuthTokenfromRefreshToken(user_identifier,refresh_token).

```

##Sample API Calls
## Sample API Calls

```
var input ={};
Expand Down Expand Up @@ -206,7 +208,7 @@ crmclient.API.MODULES.get(input).then(function(response){



##Hierarchy
## Hierarchy
zcrmsdk

```
Expand Down Expand Up @@ -255,12 +257,12 @@ For example, to call an API to get module data, the request should be zcrmsdk.AP



##Response Handling
## Response Handling
All API calls will give the actual API response given by Zoho APIs, except file download.

For file download, the response will contain an extra field filename.

##Error Handling:
## Error Handling:
All errors will be thrown explicitly and care should be taken in catching the same.


Expand Down