# data2crm-api-nodejs-sdk

> Data2CRM.API Node.js SDK

Latest version **1.1.1** (published 2016-02-08) · 0 weekly downloads

## Install

```sh
npm install data2crm-api-nodejs-sdk
pnpm add data2crm-api-nodejs-sdk
yarn add data2crm-api-nodejs-sdk
bun add data2crm-api-nodejs-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-02-08 |
| First published | 2016-01-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | http://www.data2crm.com/api/ |
| Maintainers | developers.data2crm.api |
| Keywords | data2crm, data2crm api, crm api, crm sdk |

## Links

- npm: https://www.npmjs.com/package/data2crm-api-nodejs-sdk
- Repository: https://bitbucket.org/data2crm/api-nodejs-sdk
- npm.io page: https://npm.io/package/data2crm-api-nodejs-sdk

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.60.0

## Recent versions

- 1.1.1 (latest) — 2016-02-08
- 1.1.0 — 2016-02-08
- 1.0.3 — 2016-01-15

## README

[All SDKs](/sdk)

# Node.js SDK

   * [Installation](#installation)
   * [Getting Started](#getting-started)
   * [How to Use](#how-to-use)
       * [Describe a resource](#describe-a-resource)
       * [Count all of resources](#count-all-of-resources)
       * [Fetch all of resources](#fetch-all-of-resources)
       * [Fetch a resource](#fetch-a-resource)
       * [Create a resource](#create-a-resource)
       * [Update a resource](#update-a-resource)
       * [Delete a resource](#delete-a-resource)

## <a name="installation"></a>Installation

Install with the Node.JS package manager npm

    npm install data2crm-api-nodejs-sdk

Alternately, manually add the following to your `package.json`, in the `dependencies` section:

    "dependencies": {
        "data2crm-api-nodejs-sdk": "1.0.3"
    }

## <a name="getting-started"></a>Getting Started

    // Require Data2CRMAPI SDK
    var Data2CRMAPISDK = require('data2crm-api-nodejs-sdk');

    // Create Data2CRMAPI
    var Data2CRMAPI = new Data2CRMAPISDK.Data2CRMAPI();

    // Set user key
    Data2CRMAPI.configureGlobalApiToken('X-API2CRM-USERKEY', '<USER_KEY>', 'header'); // change <USER_KEY> to your user key

## <a name="how-to-use"></a>How to Use

### <a name="describe-a-resource"></a>Describe a resource

    Data2CRMAPI.getContactDescribe(
        {
          headers: {
            'Accept': 'application/json',
            'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
          }
        },
        function(err, describe, response) {
          if (err) {
            if (err.status >= 400 && err.status <= 499) {
              console.log('Client error ' + err.status + ': ', err.message);
            } else if (err.status >= 500 && err.status <= 599) {
              console.log('Server error ' + err.status + ': ', err.message);
            } else {
              console.log('Unknown error ' + err.status + ': ', err.message);
            }
          } else {
            console.log('Describe contact result: ', describe);
          }
        }
    );

### <a name="count-all-of-resources"></a>Count all of resources

    Data2CRMAPI.getContactCountCollection(
        {
            headers: {
                'Accept': 'application/json',
                'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
            }
        },
        function(err, count, response) {
            if (err) {
                if (err.status >= 400 && err.status <= 499) {
                    console.log('Client error ' + err.status + ': ', err.message);
                } else if (err.status >= 500 && err.status <= 599) {
                    console.log('Server error ' + err.status + ': ', err.message);
                } else {
                    console.log('Unknown error ' + err.status + ': ', err.message);
                }
            } else {
                console.log('Count contact collection result: ', count);
            }
        }
    );

### <a name="fetch-all-of-resources"></a>Fetch all of resources

    Data2CRMAPI.getContactCollection(
        {
            headers: {
                'Accept': 'application/json',
                'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
            }
        },
        function(err, contact, response) {
            if (err) {
                if (err.status >= 400 && err.status <= 499) {
                    console.log('Client error ' + err.status + ': ', err.message);
                } else if (err.status >= 500 && err.status <= 599) {
                    console.log('Server error ' + err.status + ': ', err.message);
                } else {
                    console.log('Unknown error ' + err.status + ': ', err.message);
                }
            } else {
                console.log('Contact collection result: ', contact);
            }
        }
    );

### <a name="fetch-a-resource"></a>Fetch a resource

    Data2CRMAPI.getContactEntity(
        '003580000024E1IAAU',
        {
            headers: {
                'Accept': 'application/json',
                'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
            }
        },
        function(err, contact, response) {
            if (err) {
                if (err.status >= 400 && err.status <= 499) {
                    console.log('Client error ' + err.status + ': ', err.message);
                } else if (err.status >= 500 && err.status <= 599) {
                    console.log('Server error ' + err.status + ': ', err.message);
                } else {
                    console.log('Unknown error ' + err.status + ': ', err.message);
                }
            } else {
                console.log('Contact "003580000024E1IAAU" result:', contact);
            }
        }
    );

### <a name="create-a-resource"></a>Create a resource

    Data2CRMAPI.createContactEntity(
        {
            firstname: 'test first name',
            lastname: 'test last name'
        },
        {
            headers: {
                'Accept': 'application/json',
                'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
            }
        },
        function(err, contact, response) {
            if (err) {
                if (err.status >= 400 && err.status <= 499) {
                    console.log('Client error ' + err.status + ': ', err.message);
                } else if (err.status >= 500 && err.status <= 599) {
                    console.log('Server error ' + err.status + ': ', err.message);
                } else {
                    console.log('Unknown error ' + err.status + ': ', err.message);
                }
            } else {
                console.log('Create contact result:', contact);
            }
        }
    );

### <a name="update-a-resource"></a>Update a resource

    Data2CRMAPI.updateContactEntity(
        '003580000021sqUAAQ',
        {
            firstname: 'test2 first name',
            lastname: 'test2 last name'
        },
        {
            headers: {
                'Accept': 'application/json',
                'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
            }
        },
        function(err, contact, response) {
            if (err) {
                if (err.status >= 400 && err.status <= 499) {
                    console.log('Client error ' + err.status + ': ', err.message);
                } else if (err.status >= 500 && err.status <= 599) {
                    console.log('Server error ' + err.status + ': ', err.message);
                } else {
                    console.log('Unknown error ' + err.status + ': ', err.message);
                }
            } else {
                console.log('Update contact result:', contact);
            }
        }
    );

### <a name="delete-a-resource"></a>Delete a resource

    Data2CRMAPI.deleteContactEntity(
        '003580000021sqUAAQ',
        {
            headers: {
                'Accept': 'application/json',
                'X-API2CRM-CRMKEY': '<CRM_KEY>' // change <CRM_KEY> to your CRM key
            }
        },
        function(err, contact, response) {
            if (err) {
                if (err.status >= 400 && err.status <= 499) {
                    console.log('Client error ' + err.status + ': ', err.message);
                } else if (err.status >= 500 && err.status <= 599) {
                    console.log('Server error ' + err.status + ': ', err.message);
                } else {
                    console.log('Unknown error ' + err.status + ': ', err.message);
                }
            } else {
                console.log('Delete contact success');
            }
        }
    );

---
_Source: https://npm.io/package/data2crm-api-nodejs-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._