Getting Started¶
RocketShipIt at a Glance¶
RocketShipIt is a programmer’s tool kit that allows you to generate accruate rates, get tracking information, generate labels and more.
RocketShipIt’s main function is to allow you the ability to do these tasks with the least amount of code possible so you can focus on doing the real work. RocketShipIt does this by handling all communication with the carrier’s API and returning the data in usable form.
In the backend RocketShipIt is pulling information from the defaults you have set as well as the information you hand it with each request. In other words, information that is unlikly to change on a shipment by shipment basis (like your shipping address) is pulled from defaults so you don’t have to repeat it each time you need to make a request.
That said, if you have a special case when a default needs changed you can simply pass a parameter to RocketShipIt and it will change it for that one instance/request.
Technical Requirements¶
Although RocketShipIt strives to reduce requirements, there are a few that you must have:
- PHP Version 5.3+
- The PHP cURL extension
- The PHP SOAP Client
Obtaining Carrier Developer Keys¶
In order for RocketShipIt to work, it needs to access the carriers’ APIs. To prevent abuse most carriers require that you send a developer key with each request.
To use RocketShipIt you will need to sign up for a developer account with each carrier you intend to use (except Stamps.com). Once you have signed up you will be given a developer key which you will put into your RocketShipIt config file.
UPS¶
Start by registering for a UPS developer’s account.
Once you have an account with UPS you will need to login to the UPS Online Tools website and request an XML access key. AKA Developer Key
FedEx¶
To use the FedEx services you will register for a FedEx developer’s account.
Once you have an account with FedEx you will need to login to the Developer Resource Center and request a Developer XML access key. AKA Developer Key
USPS¶
Important
RocketShipIt has teamed up with Stamps.com and IntuiShip to bring you discounted rates; however, you need to make sure to sign up for a Stamps.com account through: http://www.stamps.com/rocketshipit to get the discount. If you already have an account and want the discounted rates please email shippersupport@stamps.com and request the RocketShipIt-IntuiShip rates. On some shipments you will save up to 46% off the retail USPS rates.
USPS services are separated into two different carriers, USPS and Stamps.com. USPS is usually used for interacting with Rates and Tracking only as it cannot produce postage paid labels. A Stamps.com account is required if you wish to produce labels that have postage. If you want to create a USPS label with a tracking number but without postage you can use USPS. We usually recommend using Stamps.com for all API requests if you need postage paid labels.
If you wish to use only the USPS rates and tracking services you don’t need a Stamps.com account simply register for a USPS developer’s account.
If you are using Stamps.com with RocketShipIt you do not need a Stamps.com developer account. You will use your production Stamps.com username and password to connect.
Note
The USPS (Not Stamps.com) testing API only responds to pre-definied requests. In order to send your own requests and actually test/use the API you will need to call USPS and have them move you to production Rates and Tracking.
DHL¶
Unfortunately DHL doesn’t have a form to sign up to their API. To obtain DHL XML API credentials fill out the XML-PI API new user request form and send it to john.riff (at) dhl.com. Tell him that RocketShipIt sent you.
Set Defaults Before Downloading RocketShipIt¶
RocketShipIt was designed to implement shipping features as quickly as possible. We have gone ahead and filled out your config file (config.php) with defaults that should work out of the box for the examples shown here in our documentation. The only parameters you need to change is your carrier credentials and account numbers. Make sure to change these to avoid authentication errors.
Once you have gotten a few of our examples working feel free to adjust the config parameters of your shipping workflow.
Of course if you decide that you don’t like the defaults that you have setup you can always change them in the script later or override them on a per shipment basis using the setParameter() function.
See: Shipment Parameters, Rate Parameters, Tracking Parameters, Time in Transit Parameters, Address Validation Parameters.
A Word About the Examples Contained in this Documentation¶
Important
Examples provided in this documentation assume the following defaults:
Since RocketShipIt allows users to specify defaults of almost every parameter and user configurations can change the examples contained in this guide may not produce the same results. If you are having trouble and not receiving proper responses in your code, it is recommended that you start with the following defaults until you get a proper response and then go from there.
What if I run into trouble?¶
We are standing by to help at: support@rocketship.it just make sure to send us your debug information (instructions in the Troubleshooting section) with your support request.