Accessing the APIs
To start accessing Bunnings APIs: register, log in, and create a team and an app to get some API keys.
Apps
Apps are associated with a team and contain API keys which allow you to access Bunnings APIs. You can create as many apps as you need, and also many API keys within those apps, where each of those API keys can access one or more APIs.
We recommend having one set of API keys per app as we find that is an easier way to manage what apps, API keys and the API products they have access to.
Apps also have analytics data, which you can view to see traffic, latency, errors and other information concerning the API traffic for each app.
Viewing your apps
NOTE: There are 3 Bunnings developer environments; sandbox, test and live. You will find your apps to those environments in each of the 2 associated developers portals (sandbox and test environment APIs are available in the sandbox-test portal and the live environment APIs are available in the live portal). See Environments for more details.
Create an app
Log into sandbox-test or live
Click on Teams and select the team you want to create an app under
Click on Team Apps and then click the Add team app button
Enter:
- Environment (Live), this is the only option on the Live portal
- Team App Name
- Provide a Description (optional)
- Select the API products the app will have access to
Click Add team app
Your new app will now be available in your team Apps list.
NOTE: For test and live environments, the API products you add to an app will be Pending Approval, and will be manually reviewed by Bunnings. A review normally takes no more than 3 working days. See Getting Started for more details on accessing test APIs and accessing live APIs.
NOTE2: Partner APIs are only available once unlocked with a valid Partner Access Code. That team must have a Partner Access Code associated with it to see and access Partner APIs. See Partner APIs for more details.
Delete an app
Log into sandbox-test or live
Click on Teams and select the team that owns the app you want to delete
Find the app you wish to delete, click View
From the menu on that app, click Delete
Type the app name in the text box and click Delete.
WARNING! This action cannot be undone. Once deleted any applications using API keys in that app will immediately be unable to use those keys to communicate with any Bunnings API. Creating new keys for test or live environment APIs will require re-approval of your keys for any selected products.
App Analytics
Log into sandbox-test or live
Click on Teams and select the team that owns the app you want to see analytics for
Find the app you wish to view analytics, click View
Click on Analytics
You can then select the analytics chart you wish to see for that app;
-
Traffic
-
Latency
- Errors
App API keys (or Credentials)
See API keys in our Security documentation.
Environments
We have 3 environments to help you develop your applications and safely interface with our APIs.
You can use the 3 environments as part of your SDLC in progressing your application from sandbox, to test to our live APIs.
| Sandbox | Test | Live | |
|---|---|---|---|
| Developer Portal: | |||
| Base URL: |
|
|
|
| API Access: | automatic key approval | manual key approval | manual key approval |
| Description: | Mocked responses that mimic the live API | Responses from test environment data and backends | Production responses with live data. |
| Register your account | YES | NA | NO (register on sandbox-test) |
Accessing the environments
First you’ll need to register on the sandbox-test portal, then you will be able to login to the live portal using your same credentials.
You will need to have successfully tested your application using sandbox APIs, before requesting access to test or live APIs.
See the Getting Started page for instructions on how to move from sandbox to test and then to live APIs.