Developer Centre
Getting Started

Getting Started

Here’s a quick rundown of what you need to know about working with the Starshipit API.

What do I need to start?

  1. Starshipit account and Starshipit API key
  2. At least one enabled courier in your Starshipit account
  3. Starshipit Developer account and Developer subscription key

Starshipit account: You’ll need to sign up for a Starshipit account to get an API key. You’ll also need to enable at least one courier to be able to use the rates at checkout request.

Starshipit API key: To make requests to the API, an authentication token is required. To view your API key log in to your Starshipit account, then go to Settings > API. You can generate a new token here. This is the StarShipIT-Api-Key.

Starshipit Developer account: If you don’t already have an account, register as a Starshipit Developer.

Developer subscription key: Once you have a Developer account, you’ll need to subscribe to the Developer subscription to get your subscription key. No approval is required. This is the Ocp-Apim-Subscription-Key.

API usage / Developer test bed environment

Once you have both API keys, you can go to the API References and start testing. Our API’s use the basic HTTP request codes: POST, GET, PUT.

The ‘Try it’ button in the API Reference pages enables you to test your integration by generating requests to test services and receiving responses.

When you’re ready for production, you’ll need apply for the Production subscription to ensure you’re not limited.

API rate limits

Our Developer subscription allows you to make five requests per minute, up to a maximum of 100 requests a day.

Our Production subscription allows you to make two requests per second. This subscription requires approval.

If you exceed these rates, you'll receive a ‘429 Too Many Requests’ error.