Generate an Australia Post/StarTrack API key and secret

Overview

  • Generate your Australia Post or StarTrack account number, API key and API secret.

How it works

To integrate your Australia Post account with Starshipit, you'll need to generate an API key and secret in the Australia Post Developer Centre.

Before you begin, you'll need the following:

  • Your Australia Post account number (eParcel) or Startrack account number.
  • An Australia Post Business Credit Account and an eParcel Contract. If you don't have an account, please email customer_connectivity@auspost.com.au to indicate your interest and mention that you're using Starshipit.

1. Register for an API key

Create an account in the Australia Post Centre and register for an API key.

  1. Go to https://developers.auspost.com.au/register.
  2. Complete the information, then click Create an account.
  3. Log in to your new account and go to https://developers.auspost.com.au/apis.
  4. Click Register now for an API key.

    Auspost_api.jpg

  5. Click Complete registration to confirm.
  6. Complete the registration form using your StarTrack or Australia Post account details.
  7. Select that you're accessing the API via a Platform Partner.
  8. Set Starshipit as your platform partner.

    Auspost_api_2.jpg

  9. Click Send.

Once you've completed the form, you'll have to wait up to 24 hours for Australia Post to confirm your registration.

2. Generate your API key

If you're a StarTrack user, your API key and secret are automatically emailed to you. However, if you use Australia Post you may need to manually generate an API key.

You should receive the API invitation in your email inbox. If you haven't received it within 24 hours, please check your Junk/Spam folder or contact customer_connectivity@auspost.com.au.

2.1 Create a new project

  1. In the Australia Post Developer Centre, select Projects. If the Projects header isn't visible, you'll have to wait for the confirmation email from Australia Post.
  2. Click Create New Project.
  3. Add a project name and select your organisation.
  4. Click Create project.

 2.2 Generate your API key

  1. Select API Access, then click Create a Key.
  2. Enter a key nickname and enter a Secret. This will be your username and password.
  3. Click Create a key.

2.3 Activate API services

  1. Click Services.
  2. Turn all the services on for the new project.
  3. Click Update.

    Screen_Shot_2018-04-30_at_11.58.18_AM.png

3. Send the information to Starshipit

Send the following information to Starshipit at support@starshipit.com:

  • API key
  • Secret
  • eParcel account number

What's Next?

If you're having issues, contact the Australia Post Service Desk at customer_connectivity@auspost.com.au or call on 03 91067232 / 02 8755 9417.

Follow