endicia

This gem allows you to connect to your Endicia API to print USPS labels. It is in no way meant to be exhaustive–fork away!

Configuration

You’ll need an endicia.yml file in config, with:

AccountID (6 digits)
RequesterID (string--you have to request this from Endicia)
PassPhrase (string)

and optionally

Test (set this to true while in testing and/or in development env)

Additionally, you may want to set a few defaults like your address:

FromCompany
FromCity
FromState
FromPostalCode
ReturnCompany
ReturnCity
ReturnState
ReturnCode

You can also specify any of the options that Endicia allows for ‘GetPostageLabel’ as defaults. Most of them you’ll want to pass in, but you might find it convenient to switch the default image format globally, for instance. Any options you pass in directly will override that defaults in the config file.

Cheers!

Usage

There’s only one method–get_label.

Ex. Endicia.get_label({:ToPostalCode => RECIPIENT ZIP, :ToAddress1 => RECIPIENT ADDRESS, :ToCity => RECIPIENT CITY, :ToState => RECIPIENT STATE, :PartnerTransactionID => GENERALLY THE ORDER (OR SOME MODEL) ID, :PartnerCustomerID => GENERALLY CUSTOMER/USER ID, :MailClass => SHIPPING METHOD, :WeightOz => INTEGER WEIGHT})

Contributing to endicia

Copyright © 2011 Mark Dickson. See LICENSE.txt for further details.