Help Centre
Select...

QuickStart guide

Ready to dive in and start using our APIs? You can start building in four steps.

Step 1 - Choose an API

  1. Browse our APIs and read through the documentation.
  2. Choose an API that meets your needs.

Step 2 - Set up a free account - or log in

It takes less than a minute to set up a Developer Portal user account - and it's free.

If you've already got an Australia Post account, simply log in.

To set up an account:

  1. Click or tap Log in in the top right corner, then select Sign up.
  2. Submit your email address, and we’ll send out a verification email.
  3. Once you verify your address, add a password for your account, then provide your first and last name.
  4. Accept the terms and conditions, and click or tap Sign up.

Step 3 - Add an app and credentials

  1. View the documentation for the API you're interested in.
  2. Click or tap Get credentials.
  3. Click or tap Add app, fill in the details and save.
  4. In your new app, click or tap Add credential.
  5. Confirm the API you want to use.
  6. Use the hint about the API’s security definitions to help you choose the credential type.
  7. Configure the credential details, if applicable.
  8. Click or tap Create credential.
If the API you want to use is restricted, you need to request access before you can get credentials.
Need more help? Take a look at our step-by-step How to get credentials tutorial.

Step 4 - Try out the API to see how it works

  1. Make sure you’re logged in.
  2. View the API’s documentation and click or tap the endpoint you want to try out.
  3. Click or tap Try it in the right hand panel.
  4. Select a valid credential and enter the relevant parameters.
  5. Click or tap Send.
Need more help? Take a look at our step-by-step How to try out an API tutorial.

Now you’re ready to start building!

Explore our APIs