Cloud API

RocketShipIt can be ran on your own-servers or we can host it for you in the cloud at no extra charge.

To connect to the RocketShipIt API in the cloud simply set the apiKey parameter in your client. Your RocketShipIt API key which can be found in the My Account page. You must have an active RocketShipIt subscription to receive an API key.

PHP Example

$rs->apiKey = 'ADD YOUR RocketShipIt API KEY HERE';

This will instruct the RocketShipIt PHP client to connect to RocketShipIt in the cloud as opposed to self-hosting.

Cloud Rate Limits

Current RocketShipIt Cloud API rate limits:

  • Rate: 4,000 requests/second
  • Burst: 2,000 requests
  • Quota: 100,000 requests per day
  • Response Timeout: 30 seconds (the carrier must respond within this time)

Note: Self hosted RocketShipIt has no rate limits. If you rely on the RocketShipIt Cloud API and need a high rate limit please email us.

Connect without a Client

If you don't want to use our provided API clients or want to connect to RocketShipIt from an unsupported application or programming language here is what you need to know:

The RocketShipIt Cloud API was designed to be as simple as possible. We only have one API endpoint and two required headers.

Endpoint

POST https://api.rocketship.it/v1

Note: Despite the confusing name this endpoint refers to version 1 of the RocketShipIt 2.x API not our legacy RocketShipIt 1.x API.

Required Headers

  • Content-Type: application/json
  • x-api-key: YOUR_RS_API_KEY

cURL Example

A full working cURL request to the RocketShipIt API:

curl -X POST \
  https://api.rocketship.it/v1 \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_RS_API_KEY' \
  -d '{
    "carrier": "UPS-REST",
    "action": "track",
    "params": {
        "key": "YOUR_UPS_API_KEY",
        "tracking_number": "1Z12345E0205271688"
    }
}'

Health Status

A health check URI for RocketShipIt Cloud can be found at https://api.rocketship.it/v1/health which will return a 200 status if our API is available:

curl -s -o /dev/null -w "%{http_code}" https://api.rocketship.it/v1/health
200%
← Self-HostingRating →