Getting Started

Once you’re registered you’ll be able to start developing your applications immediately by getting API Keys (by creating an app) for the sandbox environment API products.

Our sandbox APIs, including our sandbox OAuth2 endpoint, provide mocked responses which emulate the request and response structure of our test and live APIs.

You’ll need to develop against the sandbox version of the API product first before being allowed to access the test version of the API, and likewise from the test to live version of the API.

Developer Portal Environments

We have three developer portal environments to ensure segregation of sandbox, test and live APIs. Once you’ve registered on the sandbox environment, you will be able to use the same credentials to log onto the test and live portal environments.

You can also use the switcher in the top right-hand-side of the portal to switch between sandbox, test and live sites.

The Portal Environments

Using API Keys

All our APIs are protected using OAuth2 (and other security mechanisms) to ensure we know who is using our APIs and to ensure their access is valid.

Your API keys are available in the Credentials section of your app, and the API products that you can use are associated with the API keys.

This allows you to create apps and API keys (Credentials) that can be used for different purposes to help you maintain and track the usage of those keys.

Before you can use any of the Bunnings APIs, you will need to use your API keys to get a token. You can then use that token in the Authorization header for each subsequent API call.

See Security for more details.

Accessing Test APIs

Once you’ve successfully integrated your application to one or more sandbox APIs, switch over to our test site, create a new app and request access to the test version of the API product. If you are prompted to log in to our test site, use the same credentials you used for sandbox.

The API product will show “pending”, where Bunnings will approve your request after reviewing the applications.

Access requests may require further information. If this is the case, Bunnings may reach out to you to discuss your requirements.

Accessing Live APIs

The live version of our APIs are available on our live site. To access live APIs, you must first have successfully tested your application using the test APIs. If you are prompted to log in to our live site, use the same credentials you used for sandbox.

Once again, create a new app and request access to the API product in live.

The API product will show “pending”, where Bunnings will approve your request after reviewing the application.

Access requests to live may require further information. If this is the case, Bunnings may reach out to you to discuss your requirements.