data2crm-api-nodejs-sdk v1.1.1

All SDKs

Node.js SDK

• Installation
• Getting Started
• How to Use
  • Describe a resource
  • Count all of resources
  • Fetch all of resources
  • Fetch a resource
  • Create a resource
  • Update a resource
  • Delete a resource

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"
}

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

How to Use

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);
      }
    }
);

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);
        }
    }
);

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);
        }
    }
);

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);
        }
    }
);

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);
        }
    }
);

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);
        }
    }
);

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');
        }
    }
);