API Explorer

RocketShipIt comes with a built-in API explorer to quickly try the RocketShipIt API without writing a single line of code. The API explorer comes with over one hundred example requests to get you started quickly.

Each request can be inspected to see the raw request sent/received from the carrier along with other metadata. The API explorer will automatically detect and display any documents (shipping label, BOL, customs documents, etc.) returned in the response.

To start the API explorer run: ./RocketShipIt -s or RocketShipIt.exe -s on Windows and then navigate to http://localhost:8080 to get started.

Screenshots

A RocketShipIt request and response:

RocketShipIt API Explorer

The API Explorer will automatically try to show a media preview returned by the shipping carrier:

RocketShipIt API Explorer requests

Defaulting Carrier Credentials

If you use the API Explorer a lot you might find it tedious to enter your carrier credentials each time. You can default your carrier credentials using environment variables:

export RS_UPS_KEY="yourkey"
export RS_UPS_USERNAME="yourusername"
export RS_UPS_PASSWORD="yourpass"
export RS_UPS_ACCOUNT_NUMBER="youraccount"

Format:

RS_THECARRIER_PARAMETER

Once set simply omit them in your request.

More about environment variables:

Options

By default all responses with large values will be truncated for readability followed by ...

Example:

{
  "data": {
    "billing_weight": 4,
    "charges": 13.15,
    "documents": null,
    "errors": null,
    "packages": [
      {
        "documents": [],
        "label": "iVBORw0KGgoAAAANSUhEUgAAAyAAAAV4CAIAAADXHy6fAABTzElEQVR4nOzd7fajKNc32soedf6nnD1G565ceRLFJSwQdc5P3SlFfEn8/RHk//sDAECqv3/+/Hk+n0dXAwDgIh6PhxYsAIBkAhYAQDIBCwAgmYAFAJBMwAIASPZ37wqPx+P3w/I4xM9V4kt+Lr9YwvvD32V+Cyn8a6Hk8j997svv51+frFWgUMiuOgMA83hU3KRfN/6vzLFYyO8/rS28+Pnnh2sLlAt/f1Kuc3lDm1uJ7+zmoSvUJH7Y4dTif5IVVvxSKCfyl8yuykT+mgKuLec1DWsNSIsJYHHhuqzwlXtSrCWeTjbb3uBuZv46PP5TvcDMuwak2/2IcBLBdPVeprzwnH9ZnrHOcKDNR/l1awWDUXmj0hXcTa9O7oVGqa9mm/KSa08eI/Fi88/NcuXLdQDSzZlCFrsufKl+rAlcVULAGtwZaMAzu2l/6OHCZv7SyUzA...",
        "label_format": "image/png",
        "tracking_number": "1Z0W4A780398058986"
      }
    ],
    "shipment_id": "1Z0W4A780398058986",
    "tracking_number": "1Z0W4A780398058986"
  },
  "meta": {
    "code": 200,
    "error_message": ""
  }
}

To disable this feature and show complete values add ?expand=true to the API Explorer url: http://localhost:8080?expand=true.

← Getting StartedErrors →