StarShipIT API - Getting Started


1. Introduction

The StarShipIT API is organized around REST. Our API has predictable-oriented URLs, and these have been based on industry standard practise and naming conventions.

Our API can we used to access not only your StarShipIT account but also our rebranded solutions, including NZPost eShip.

The API Reference provides an interface for testing the API and it should be possible to get this working within a matter of minutes once you have an account and the two API Keys required.

StarShipIT is always improving and we are building out our API continuously.


2. Authentication

Authenticate your account when using the API by including two keys in your request header. The first is your developer subscription key and you can find this once you create an account in the developers portal. The second key is your Account API key. This can be found within your StarShipIT account (or eShip account) under Settings > API.

Ocp-Apim-Subscription-Key Go to Products from the menu above, and subscribe to the "Developer Subscription".
You will then be taken to a page where you can find your key.
Once subscribed you can find you keys under your profile here.
StarShipIT-Api-Key Available under your StarShipIT (or eShip account). Go to Settings > API
You must have a valid StarshipIT or eShip account to get an API key.

3. Rate Limiting

There are two subscriptions available, the Developer subscription and the Production subscription which requires approval.

While using the developer subscription you can make 5 calls per minute.

On the production subscription you can make 2 calls per second.


4. SDKs

Coming soon.


5. Samples

Coming soon.