lob-node

Node.js wrapper for the Lob.com API. See full Lob.com documentation here.

Table of Contents

• Getting Started
  • Registration
  • Installation
  • Usage
  • Options
• Examples
• API Documentation
• Contributing
• Testing

Getting Started

Here's a general overview of the Lob services available, click through to read more.

• Simple Postcard Service
• Simple Letter Service
• Simple Check Service
• Simple Print Service
• Simple Area Mail
• Address Verification

Registration

First, you will need to first create an account at Lob.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the Settings Panel.

Installation

lob-node can be installed through the npm:

$ npm install lob

To build and install from the latest source:

$ git clone git@github.com:lob/lob-node.git
$ npm install

Usage

var Lob = require('lob')('YOUR API KEY');

// change api version
var Lob = require('lob')('YOUR API KEY');

// change internal defaults (e.g. host)
var options = {/* see options below */};
var Lob = require('lob')('YOUR API KEY', options);

// you can also just pass options
var options = { apiKey: 'foo', host: 'bar' };
var Lob = require('lob')(options);

// callback pattern
Lob.settings.list({ type: 1 }, function (err, body) {
  if (err) return callback(err);
  return callback(null, body.data);
});

Additionally, every resource method returns a promise, so you don't have to use the regular callback. E.g.

var Lob = require('lob')('YOUR API KEY');

Lob.settings.list({ type: 1 })
.then(function (res) {
  console.log(res.data);
})
.catch(function (e) {
  console.log(e);
});

Options

The Lob constructor accepts an options object which may contain one or more of the following options:

• apiVersion - Optionally set the version of the Lob API to use. Defaults to latest.
• host - Override the default host API calls are issued to.
• userAgent - Override the default userAgent.
• headers - Edit the headers sent in all API calls.

Examples

We've provided various examples for you to try out here.

There are simple scripts to demonstrate how to create all the core Lob objects (checks, letters, postcards. etc.) as well as more complex examples that utilize other libraries and external files:

• Creating Dynamic Postcards with HTML and Data From a CSV

API Documentation

• Introduction
• Versioning
• Image Prepping
• Addresses
  • Address Book
    • Create an Address
    • Retrieve an Address
    • Delete an Address
    • List all Addresses
  • Simple Address Verification
    • Verify an Address
• Simple Postcard Service
  • Postcards
    • Create a Postcard
    • Retrieve a Postcard
    • List all Postcards
• Simple Letter Service
  • Letters
    • Create a Letter
    • Retrieve a Letter
    • List all Letters
• Simple Check Service
  • Checks
    • Create a Check
    • Retrieve a Check
    • List all Checks
  • Bank Accounts
    • Create a Bank Account
    • Retrieve a Bank Account
    • List all Bank Accounts
    • Verify a Bank Account
    • Delete a Bank Account
• Simple Print Service
  • Jobs
    • Create a Job
    • Retrieve a Job
    • List all Jobs
  • Objects
    • Create an Object
    • Retrieve an Object
    • Delete an Object
    • List all Objects
  • Settings
    • Retrieve a Setting
    • List all Settings
• Simple Area Mail
  • Areas
    • Create an Area Mailing
    • Retrieve an Area Mailing
    • List all Area Mailings
  • Routes
    • Retrieve a Zip Code
    • List all Zip Codes
• Resources
  • Countries
    • List all Countries
  • States
    • List all States
• Appendix
  • SPS Templates
  • Custom Fonts with HTML
  • Postcard HTML Examples
  • Area HTML Examples
  • Letter HTML Examples

Contributing

To contribute, please see the CONTRIBUTING.md file.

Testing

To run the tests with coverage:

gulp testCI

To run the tests without coverage:

gulp test

=======================

Copyright © 2013 Lob.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.