node-exacttarget

A node.js library for the exacttarget API (further details: https://developers.exacttarget.com)

node-exacttarget exposes the following features of the exacttarget API to your node.js application:

Caution - some of these routes are not officially supported or listed in the api and may change

Version v3

• user-details

Installation

Installing using npm (node package manager):

npm install node-exacttarget

If you don't have npm installed or don't want to use it:

cd ~/.node_libraries
git clone [email protected]:Datahero/node-exacttarget.git

Please note that parts of node-exacttarget depend on request by Mikeal Rogers. This library needs to be installed for the API to work. Additionally node-querystring is required. If you are using npm all dependencies should be automagically resolved for you.

Usage

Information on how to use the exacttarget APIs can be found below. Further information on the API methods available can be found at https://developer.exacttarget.com. You can also find further information on how to obtain an API key, and/or OAuth2 in your exacttarget account and much more on the exacttarget API pages.

exacttarget API

exacttargetAPI takes an options object, The only required option for version3 of the api is an oAuth token.

http://developer.exacttarget.com/docs/auth/

All API requests must be authenticated with a valid OAuth token. Tokens are tied to user accounts; if you’re just using the API for a single user or organizer, then follow ‘Personal Tokens’ if you’re using the API for many exacttarget users, then follow ‘OAuth Token Flow’. which you can find in your exacttarget Account. The second argument is an options object which can contain the following options:

required options:

• token

available options

• version The API version to use. Defaults to v3.
• userAgent Custom User-Agent description to use in the request header.
• contentType defaults to application/json and currently the api only supports json

The callback function for each API method gets two arguments, an error and results object.

The error object is null when no error occured. The results object contains all information retrieved as long as no error occurred.

Example:

var ExactTarget = require('node-exacttarget');

var client;

try {
  client = exacttargetAPI();
} catch (error) {
    console.log(error); // the options are missing, this function throws an error.
}
client = exacttargetAPI({
    username: process.env.USERNAME,
    password: process.env.PASSWORD
  });

// IF you have an oauth token, you can use that instead. 
token = 'a users exacttarget API token';
client = exacttargetAPI({token: token});


// login
// - will confirm that the username/password is correct.
// - will conrirm that the WSDL is correct. 

client.login({}, function (error, data) {
  
    if (error) {
        console.log(error.message);
    } else {
        console.log(JSON.stringify(data)); // Do something with your data!
    }
});

License

node-exacttarget is licensed under the MIT License. (See LICENSE)

Contributors