QuickStart guide
Ready to dive in and start using our APIs? You can start building in four steps.
Step 1 - Choose an API
- Browse our APIs and read through the documentation.
- 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:
- Click or tap Log in in the top right corner, then select Sign up.
- Submit your email address, and we’ll send out a verification email.
- Once you verify your address, add a password for your account, then provide your first and last name.
- Accept the terms and conditions, and click or tap Sign up.
Step 3 - Add an app and credentials
- View the documentation for the API you're interested in.
- Click or tap Get credentials.
- Click or tap Add app, fill in the details and save.
- In your new app, click or tap Add credential.
- Confirm the API you want to use.
- Use the hint about the API’s security definitions to help you choose the credential type.
- Configure the credential details, if applicable.
- 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
- Make sure you’re logged in.
- View the API’s documentation and click or tap the endpoint you want to try out.
- Click or tap Try it in the right hand panel.
- Select a valid credential and enter the relevant parameters.
- Click or tap Send.
Need more help? Take a look at our step-by-step How to try out an API tutorial.