blueflag_logo

Getting Started#

Start making test requests as soon as you create a Blue Flag account. It only takes two steps.

  1. Create your API key so that Blue Flag can authenticate requests from your application.

  2. Make test API requests to confirm everything works and view sample data.

1. Create Your API Key#

Requests to the Blue Flag API are authenticated by using your API key. If you do not provide an api key or if you provide an invalid key, Blue Flag with reject your request and return an error.

You can create two types of keys to make sandbox (test) or live requests. Sandbox requests are free and allow you to test your integration and view sample data. Live requests will return the real data which will be billed according to the price guide. You can create either key via the Dashboard.

2. Make Test API Requests#

AUTHENTICATION

The Blue Flag API uses API keys to authenticate requests. You can view and manage your API keys in the Blue Flag Dashboard.

Sandbox (test) keys have the prefix 'secretSANDBOX' and live keys have the prefix 'secretLIVE'.

Use your API key by setting it as the Authorization header of your https request.

Request:

curl
1
curl "https://sandbox.blueflag.com.au/nevdis/vehicle_details?plate=TESTPLATE1&state=VIC" \
2
-H "Authorization: [insert your api key]"

Response:

json
1
{
2
"request_id": "604e7e4f-173f-4de0-8064-652af59af4d8",
3
"result": [
4
{
5
"vin": "KMHAAAAAAATESTVIN",
6
"chassis": null,
7
"registration": {
8
"plate": "TESTPLATE1",
9
"state": "VIC"
10
},
11
"make": "HYUNDAI",
12
"model": "I30",
13
"colour": "SILVER OR CHROME",
14
"body_type": "CAR/SEDAN",
15
"vehicle_type": "CAR / SMALL PASSENGER VEHICLE",
16
"engine_number": "G40000000000"
17
}
18
]
19
}