fuel-auth

Fuel Auth (for Node.js)

This library allows users to create authentication clients for ExactTarget APIs.

Accessing ExactTarget's API

This is a new library and requires extensive testing. Feel free to test it out and submit issues as they are found.

Initialization

new FuelAuth( options )

• options
  • required: yes
  • Type: Object
    • clientId - required
    • clientSecret - required
    • authUrl - not required
      • default: https://auth.exacttargetapis.com/v1/requestToken

API

1. getAccessToken( options, callback )
   • options
     • required: no
     • Type: Object
     • Extra options used on token request. See request modules options
   • options.force
     • required: no
     • Type: Boolean
     • default: false
     • If true, token will always be requested from API regardless of expiration
   • callback( error, data )
     • required: yes
     • Type: Function
     • Function that will be executed after token request completes
     • parameters
       • error - error encountered. null if no error
       • data - object with data and response
         • accessToken ( data.accessToken ) - access token
         • expiresIn ( data.expiresIn ) - time until token expiration
2. checkExpired()
   • Returns boolean value. true if token is not expired and it exists. false if token is expired or it doesn't exist.

Setting up the client

var FuelAuth = require( 'fuel-auth' );

// Required Settings
var myClientId     = 'yourClientId';
var myClientSecret = 'yourClientSecret';

// Minimal Initialization
var FuelAuthClient = new FuelAuth({
	clientId: myClientId // required
	, clientSecret: myClientSecret // required
});

// Initialization with extra options
var authUrl      = "https://auth.exacttargetapis.com/v1/requestToken"; //this is the default
var accessToken  = "";
var refreshToken = "";

var FuelAuthClient = new FuelAuth({
	clientId: myClientId // required
	, clientSecret: myClientSecret // required
	, authUrl: authUrl
	, accessToken: accessToken
	, refreshToken: refreshToken
});

Examples

var options = {
	// whatever request options you want
	// See https://github.com/mikeal/request#requestoptions-callback

	// I want to force a request
	force: true
};

FuelAuthClient.getAccessToken( options, function( err, data ) {
	if( !!err ) {
		console.log( err );
		return;
	}

	// data.accessToken = your token
	// data.expiresIn = how long until token expiration
	console.log( data );
});

// OR don't pass any options
FuelAuthClient.getAccessToken( function( err, data ) {
	if( !!err ) {
		console.log( err );
		return;
	}

	// data.accessToken = your token
	// data.expiresIn = how long until token expiration
	console.log( data );
});

Contributors

In alphabetical order

• Kelly Andrews - twitter, github
• Alex Vernacchia - twitter, github
• Doug Wilson - twitter, github

ChangeLog

• 0.5.0 - 2014-08-06
  • updated request dependency version due to qs module security vulnerability
• 0.4.0 - 2014-08-06
  • removed event emitter - breaking
• 0.3.0 - 2014-08-05
  • getAccessToken API change - breaking
• 0.2.1 - 2014-08-05
  • completed unit tests
  • npm package update
  • changing require name to fuel-auth
  • added license
  • readme update
• 0.2.0 - 2014-06-25
  • refactored object constructor
  • removed context from getAccessToken API
  • docs/readme updates
• 0.1.1 - 2014-06-23
  • readme updates
• 0.1.0 - 2014-06-23
  • adding callbacks to getAccessToken API
  • adding ability to pass extra request options to getAccessToken API
  • adding ability to force token request from ExactTarget API
  • adding check for expired token
• 0.0.1 - 2014-06-22
  • added event emitter for delivery of data
  • setup travis
  • refactoring of unit tests
  • semantic changes
  • initial commits