A Node.js wrapper around Northern911 SOAP api. For more information about this API please read Northern911 SOAP API Overview
$ npm install northern911-api --save
constructor to initialize the module
vendorCode
- vendor code given by Northern
password
- password given by Northern
sandbox
- (default: false) module will use Northern sandbox SOAP url if true
function to establish connection with Northern SOAP API
callback
- function(error) callback upon connection. All module functions have to be executed within
Returns current data for the requested record. https://addressinfo.northern911.com/soapapidocs/#Query
phoneNumber
- Customer phone number.
callback
- function(error, result, body). error contains error, result contains JSON result object and body contains full XML body result
Get a URL to download the entire vendor database as CSV. https://addressinfo.northern911.com/soapapidocs/#VendorDump
callback
- function(error, result, body). error contains error, result contains JSON result object and body contains full XML body result
Add new or update existing client record. https://addressinfo.northern911.com/soapapidocs/#AddUpdate
options.phoneNumber
- Customer phone number. Must be 10 digits
options.lastName
- Last name or company name
options.firstName
- First name
options.lastDateTimeModified
- Last date modified
options.lastDateTimeModifiedUnixTime
- Last date modified in Unix time
options.streetNumber
- Street number
options.suiteApt
- Suite or apartment number
options.streetName
- Street name
options.city
- City
options.provinceState
- Two letter province or state code
options.postalCodeZip
- Canadian postal code or USA zip code
options.otherAddressInfo
- Other information
options.enhancedCapable
- Yes or No. Must be 'Y' or 'N'.
callback
- function(error, result, body). error contains error, result contains JSON result object and body contains full XML body result
This does not modify customer details and only verifies whether or not the data passed to AddorUpdateCustomer would succeed. https://addressinfo.northern911.com/soapapidocs/#Verify
options.phoneNumber
- Customer phone number. Must be 10 digits
options.lastName
- Last name or company name
options.firstName
- First name
options.lastDateTimeModified
- Last date modified
options.lastDateTimeModifiedUnixTime
- Last date modified in Unix time
options.streetNumber
- Street number
options.suiteApt
- Suite or apartment number
options.streetName
- Street name
options.city
- City
options.provinceState
- Two letter province or state code
options.postalCodeZip
- Canadian postal code or USA zip code
options.otherAddressInfo
- Other information
options.enhancedCapable
- Yes or No. Must be 'Y' or 'N'.
callback
- function(error, result, body). error contains error, result contains JSON result object and body contains full XML body result
Delete an existing client record. https://addressinfo.northern911.com/soapapidocs/#Delete
phoneNumber
- Customer phone number.
callback
- function(error, result, body). error contains error, result contains JSON result object and body contains full XML body result
property which contains production or sandbox url this module will be connecting to
property which contains current hash which will be sent to Northern for authorization for every request
var Northern911API = require('northern911-api');
var northern911API = new Northern911API({
vendorCode: '', // put your vendor code here
password: '', // put your vendor password here
sandbox: true
});
northern911API.connect(function(error) {
if (error) {
return console.error(error);
}
northern911API.queryCustomer('6470001234', function(error, result, body) {
console.log(body);
console.log();
console.log(result);
if (error) {
console.error(error);
}
});
});
For more examples check example.js
node example.js
MIT license; see LICENSE.
(c) 2015 by Alexey Novak