FAQ

Can I explore the APIs if I don’t have a developer account?

Yes. You can view our documents and browse our public APIs without an account.

How do I access the APIs?

You will first need to register on our sandbox site. To access an API, follow the instructions outlined in Accessing the APIs.

Why are there two developer portals?

In order to ensure you are ready to use our production APIs, we have provided two portals so that you can progress the development of your API from sandbox to test and eventually to the live version of our API. You can read more about our developer portals and API environments in Accessing the APIs.

How do I log in?

First you need to register an account on our sandbox-test portal. Once you’ve registered, you can use the same log in details on sandbox-test or live portals.

What is the service availability of the APIs?

Our service availability on all our live APIs (unless otherwise stated) is 99.95 percent.

Do I need to register to access the APIs?

Yes, you will need to register to access any of our APIs.

When can I register a developer account?

You can register a developer account at any time in our sandbox-test portal.

Can I use the same developer account on live portal?

Yes, once you have registered in sandbox-test you can use your same login details on the live portal.

What is a team?

A team is a group of one or more developers for the management, visibility and sharing of apps and API keys across multiple developers who are members of the team.

How do I register a team?

You can create a team by following the instructions in Teams.

Where can I see my team account?

Once you’ve created a team or once you’ve been added as a member of a team, when you log in your will be taken to the Your Teams page, or you can use the Team Switcher in the top-left of the portal.

Who administers the team?

Team Owners administer a team. From your Team, click on the members to see a list of who is part of a team and what role they have.

How do I add or remove members from a team?

See Your Teams for details.

Can I add team members who aren’t registered on the Bunnings developer portal?

No, any developer invited to be part of your team must already be registered on the developer portal.

How do I change my team’s administrator/owner?

The administrator of the team may change or add another admin under the members section of the Team.

Is my developer account connected to an approved team?

Log in and navigate to Your Teams. If you do not see a team then you have not created a team, or have not yet been added to a team. If a team already exists for your business, see your IT administrator for details on getting access.

Will I receive an email when I have been added to a team?

Yes, you will receive an invitation to teams you’ve been invited to. You can accept the invitation by clicking on the link in the email, or by logging in, going to My Profile and accepting the invitation from there.

Can my developer account be added to more than one team?

Yes.

Do I need API keys to use Bunnings APIs?

Yes, all our APIs are protected by OAuth2, which require valid APIs keys to use our APIs.

Do I need different API keys for sandbox, test and live versions of the same API?

Yes, separate API keys are required to access the same API from sandbox, test and live. Login to each portal to see the API keys for sandbox, test (sandbox-test portal) and live (live portal).

How do I select the environment to use in my app in the sandbox-test portal?

When you create an app in the sandbox-test portal you can select whether the app environment is for Sandbox or Test APIs. Once the app is saved that app is locked to that environment. In the live portal, apps are locked to the Live environment and those keys can only access Live APIs.

How can I tell which environment my app is for?

The environment (sandbox, test or live) that an app is tied to is displayed next to the app name and will show either “Sandbox”, “Test” or “Live” depending on the environment the app is created against. Once an environment has been set for an app during creation it cannot be changed.

The app’s API keys can only be used against endpoints associated with the app’s environment (e.g. the API key on a sandbox app can only be used against the sandbox OAuth2.0 endpoint)

How do I get API keys?

Once you’ve logged in (to sandbox-test or live), go to Accessing the APIs .

How do I get access to test and live APIs?

API keys in these environments are manually approved by Bunnings. When you create a set of API keys in these environments, the API products associated with those API keys will be pending until approved by Bunnings.

Are there other APIs available besides the public APIs?

Yes, partner APIs are available to our partners and those we have a strategic relationship with. If you are a Bunnings partner and need access to our partner APIs, see Partner APIs.

When trying to submit a Product Access Code I receive the error "Something went wrong, please try again later."?

The Product Access Code you entered is either invalid, or it has expired. Check that you've entered the correct code (it is case-sensitive). If you are still having trouble please Contact Us.

I want to replace an existing API key. How do I do this?

See Security for revoking and deleting API keys, or you can delete the app that contains those API keys. (Be careful as you may have other API keys in that app that might still be in use). If you’re still stuck, you can Contact Us to replace your API keys for you.

I want to get new API keys. How do I do that?

See Security on getting new API keys. Alternatively, create a new app to get new API keys.

Why is my consumer key and consumer secret not working?

There can be a number of reasons for this:

·         You're trying to use API keys against the wrong environment (e.g. sandbox keys against test APIs).

·         Your API key might be revoked or pending and therefore not usable.

·         Your app might be revoked or pending and any API keys in that app will not be usable.

·         The API product you’re trying to use listed under those API keys is pending.

·         The API product you’re trying to use is not listed under your API keys.

What is the API reference on each API?

Also known as an Open API Specification 3 document, this is a YAML file that provides users with an understanding of what the API is and how it can be used. You can also download the API reference file for each API; when used in conjunction with other tools, it can provide sample code for you to use the API.

What is the Postman collection on each API?

Postman is a common tool used by software developers to get started with understanding and testing of APIs. Our Postman collections define the endpoints, requests and example responses for the API so that you can get started swiftly. We recommend you download the Postman desktop version and use our Postman collections provided to quickly get started with our APIs.

How do I use the Postman collection?

Each API has a downloadable Postman collection as a JSON file. Import this collection into your Postman tool (using the Import button in Postman). Once imported, here’s how you can use your API keys to get started with the API:

I have an unknown error. Where can I get help?

First check out Error Codes. If you’re still unsure, please  Contact Us.

How do I report bugs or request new API features?

Reach out to us via the Contact Us form.